diff --git a/docs/background.html b/docs/background.html index f3a4fc02..df6781bd 100644 --- a/docs/background.html +++ b/docs/background.html @@ -386,7 +386,7 @@
< Diagram >
+The Gaia Framework is divided into three main +parts:
+A readily-extensible catalog of source datasets. Gaia Catalog +contains metadata for public geospatial datasets. Descriptive metadata +facilitates search and discovery of relevant datasets. Functional +metadata (machine-actionable instructions) enables automated retrieval, +extraction, transformation, and loading of public datasets and their +constituent variables.
+Gaia Core is the central functionality and storage of Gaia and itself +consists of two main features: a staging database and +an execution engine.
+The staging database is a PostGIS database with a replica copy of the +Gaia Catalog installed in a schema named “backbone”. In this database, +public datasets that are registered in Gaia Catalog can be “staged”: +transformed and then loaded as tables in a standardized +Entity-Attribute-Value format. Other geospatial data, such as geocoded +addresses, can also be loaded into the staging database for use in +conjunction with the staged data.
+All operations on the staging database (creating tables, inserting +data, accessing data, etc.) are performed through the “execution +engine”. The execution engine can be any software package (e.g. R +package, Python library, CLI) that connects to the database and +functionalizes the logic required to write or read data to and from the +standard format. Currently, there is one execution engine: an R Package +named gaiaCore.
+Any functionality that falls outside of Gaia Core’s scope (basic +Create, Read, Update and Delete operations) can be encapsulated in an +Extension. An extension can be thought of as a software package or +library that interfaces with Gaia Core (through the execution engine) +that collects similar functionality. Extensions can be grouped by the +communities they serve or by the functionality they provide. For +example, the gaiaOHDSI +extension is built to provide members of the OHDSI community useful +connectors between Gaia Core and an OMOP database and various OHDSI +tools. On the other hand, general (hypothetical) extensions like gaiaVis +or gaiaLayer provide visualization and layer building software to Gaia +Core, respectively.
+A readily-extensible catalog of source datasets. Gaia Catalog +contains metadata for public geospatial datasets. Descriptive metadata +facilitates search and discovery of relevant datasets. Functional +metadata (machine-actionable instructions) enables automated retrieval, +extraction, transformation, and loading of public datasets and their +constituent variables.
+The ultimate vision of Gaia Catalog is a web-hosted +repository where users can access and contribute functional and +descriptive metadata for public datasets to facilitate their standard +use across networks and beyond. Currently, the data for +still-developing catalog is contained in the OHDSI GIS WG GitHub +Repository:
+The data_source.csv +file contains information on public datasets.
+The variable_source.csv +file contains information on the variables contained in those +datasets.
+To start using the Gaia Catalog see the article Getting Started with +Gaia.
+Documentation: GaiaCore (R -Package)
+Gaia Core is the central functionality and storage of Gaia and +consists of two main features: a staging database and +an execution engine.
+The staging database is a PostGIS database with a replica copy of the +Gaia Catalog installed in a schema named “backbone”. In this database, +public datasets that are registered in Gaia Catalog can be “staged”: +transformed and then loaded as tables in a standardized +Entity-Attribute-Value format. Other geospatial data, such as geocoded +addresses, can also be loaded into the staging database for use in +conjunction with the staged data.
+All operations on the staging database (creating tables, inserting +data, accessing data, etc.) are performed through the “execution +engine”. The execution engine can be any software package (e.g. R +package, Python library, CLI) that connects to the database and +functionalizes the logic required to write or read data to and from the +standard format.
+The ultimate vision of Gaia Core is support for +multiple geospatial databases (particularly cloud-native), as well as +execution engine interfaces for multiple popular data science +programming languages (e.g. Python, Julia, R, Bash). +Currently, the staging database has only been +implemented in PostGIS and the execution engine has only been +implemented in R.
+Any functionality that falls outside of Gaia Core’s scope (basic +Create, Read, Update and Delete operations) can be encapsulated in an +Extension. An extension can be thought of as a software package or +library that interfaces with Gaia Core (through the execution engine) +that collects similar functionality. Extensions can be grouped by the +communities they serve or by the functionality they provide. For +example, the gaiaOHDSI extension is built to provide members of the +OHDSI community useful connectors between Gaia Core and an OMOP database +and various OHDSI tools. On the other hand, general (hypothetical) +extensions like gaiaVis or gaiaLayer provide visualization and layer +building software to Gaia Core, respectively.