The Chloris Platform Data Model
The Chloris Platform data model is organized around a handful of key concepts:
- Everything belongs to an organization
- An organization can contain multiple sites
- Individual sites are defined by geospatial (multi)polygon boundaries
- Sites can be organized using one or more tags
- Sites and aggregated tag summaries are both referred to as "reporting units"
- A site may have a single "control reporting unit" for display purposes
Conceptual entity relationship map
Shown here are the things that make up the data model, and how they relate to each other. Each node represents an entity. Arrows indicate the direction of the relationship. For example, a site belongs to an organization. Solid lines indicate "materialized" elements which are queryable and can be returned in a response. Dashed lines indicate elements which exist conceptually, but require additional processing to materialize. For example, several sites can be tagged "ARR", but the tag is materialized by aggregating the results of all unique sites with the tag and storing the results as a new reporting unit entry with the branchId set to the tag name.
See also Output datasets.
The reporting unit
When requesting reporting units from the API, the reporting unit status and a few key summary statistics. This initial result is referred to the "reporting unit entry".
Each reporting unit may also have the following additional data files associated with it, each located under the dataPath attribute*:
- The boundary file, which the reporting unit entry refers to by
boundaryPath* - The stats file, which contains additional summary statistics, both for the entire period of interest, and annually. The stats file is always located at
:dataPath/stats.json - The layers config file, which contains the configuration for the layers displayed in the Chloris Platform web interface. The layers config file is always located at
:dataPath/layers.json. See Pre-computed webtiles. - The downloads index file, which contains a list of all the downloadable files associated with the reporting unit. The downloads index file is always located at
:dataPath/downloads.json. See Geotiff raster file downloads.
* dataPath and boundaryPath may refer to s3://chloris-app-data/, which is a private bucket. Replace s3://chloris-app-data/ with https://app.chloris.earth/ to download the files.