@hestia-earth/schema
Version:
HESTIA Schema
783 lines (782 loc) • 35.4 kB
TypeScript
import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Organisation } from './Organisation';
import { Term } from './Term';
import { Source } from './Source';
import { Measurement } from './Measurement';
import { Management } from './Management';
import { Infrastructure } from './Infrastructure';
import { IOrganisationJSONLD } from './Organisation';
import { ITermJSONLD } from './Term';
import { ISourceJSONLD } from './Source';
import { IOrganisationPivoted } from './Organisation';
import { ITermPivoted } from './Term';
import { ISourcePivoted } from './Source';
import { TermTermType } from './Term';
export declare enum SiteSiteType {
'agri-food processor' = "agri-food processor",
'animal housing' = "animal housing",
cropland = "cropland",
'food retailer' = "food retailer",
forest = "forest",
'glass or high accessible cover' = "glass or high accessible cover",
lake = "lake",
'other natural vegetation' = "other natural vegetation",
'permanent pasture' = "permanent pasture",
pond = "pond",
'river or stream' = "river or stream",
'sea or ocean' = "sea or ocean"
}
export declare enum SiteTenure {
'farming on common land' = "farming on common land",
'farming on owned land' = "farming on owned land",
'farming on rented land' = "farming on rented land",
'other tenure model' = "other tenure model",
'share farming' = "share farming"
}
export declare enum SiteDefaultMethodClassification {
'consistent external sources' = "consistent external sources",
'estimated with assumptions' = "estimated with assumptions",
'expert opinion' = "expert opinion",
'inconsistent external sources' = "inconsistent external sources",
modelled = "modelled",
'non-verified survey data' = "non-verified survey data",
'physical measurement' = "physical measurement",
'unsourced assumption' = "unsourced assumption",
'verified survey data' = "verified survey data"
}
/**
* Contains all the TermTermType with override on the Site.
* Note: it does not contain the default TermTermType on related Blank Nodes.
*/
export declare const siteTermTermType: {
country: TermTermType[];
region: TermTermType[];
all: TermTermType[];
};
/**
* Contains all the fields that make the blank nodes unique.
*/
export declare const siteUniquenessFields: {
measurements: string[];
management: string[];
infrastructure: string[];
};
/**
* The area on which a Cycle occurred. Typically a field for growing crops or grazing animals, an aquaculture pond, a building, or semi-natural vegetation. Sites can also be whole farms, regions, or countries.
*/
export declare class Site extends JSON<SchemaType.Site> {
/**
* An automatically generated name for the Site composed of: <code>[siteType](/schema/Site#siteType)</code>, "-", <code>[organisation.name](/schema/Site#organisation)</code>, "-", <code>[region](/schema/Site#region)</code> "," <code>[country](/schema/Site#country)</code>, "-", <code>description</code>.
*/
name?: string;
/**
* A description of the Site, including information that cannot be captured with other fields.
*/
description?: string;
/**
* A reference to the [Organisation](/schema/Organisation) this Site is managed by.
*/
organisation?: Organisation;
/**
* The type of the Site. Definitions for agricultural land follow [FAOSTAT](https://www.fao.org/fileadmin/templates/ess/ess_test_folder/Definitions/Land_Use_Definitions_FAOSTAT.xlsx), where cropland here means arable land and permanent crops. The additional term "glass or high accessible cover" is defined by [EUROSTAT](https://ec.europa.eu/eurostat/cache/metadata/Annexes/apro_cp_esms_an1.pdf).
*/
siteType?: SiteSiteType;
/**
* The ownership status of the Site following [EUROSTAT](https://ec.europa.eu/eurostat/statistics-explained/index.php?title=Glossary:Type_of_tenure) terminology.
*/
tenure?: SiteTenure;
/**
* If data on multiple Sites are aggregated and represented as a single Site, the number of Sites.
*/
numberOfSites?: number;
/**
* A nested [GeoJSON](https://tools.ietf.org/html/rfc7946) object for the Site boundary of type 'FeatureCollection', 'Feature' or 'GeometryCollection' in the WGS84 datum. For cropland the boundary should represent [area under cultivation](https://www.fao.org/faostat/en/#data/QCL/metadata) (also called sown area).
*/
boundary?: object;
/**
* The area of the Site in hectares. For cropland, this must be [area under cultivation](https://www.fao.org/faostat/en/#data/QCL/metadata), also called sown area. Harvested area, which can be less than sown area, can be defined for each Cycle using the field <code>[harvestedArea](/schema/Cycle#harvestedArea)</code>. If data from more than one Site has been averaged (<code>[numberOfSites](/schema/Site#numberOfSites)</code> is greater than one) the area must also be the mean area across Sites and not the sum of areas. If the Site is a country or region, the area must be the area represented by the Cycle data (e.g., the area of the sampled farms or the area of maize production in a country).
*/
area?: number;
/**
* The standard deviation of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaSd?: number;
/**
* The minimum of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaMin?: number;
/**
* The maximum of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaMax?: number;
/**
* The latitude of the centroid of the Site (-90 to 90, WGS84 datum). Latitude should be provided with at least five decimal place precision (which roughly corresponds to 1 meter precision at the equator).
*/
latitude?: number;
/**
* The longitude of the centroid of the Site (-180 to 180, WGS84 datum). Longitude should be provided with at least five decimal place precision.
*/
longitude?: number;
/**
* The country from the [Glossary](/glossary?termType=region).
*/
country?: Term;
/**
* The most specific geographical region from the [Glossary](/glossary?termType=region).
*/
region?: Term;
/**
* The [Global Location Number](https://en.wikipedia.org/wiki/Global_Location_Number).
*/
glnNumber?: string;
/**
* The date in which the Site in its current form was established in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* The date in which the Site in its current form ceased to exist in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The default classification of the method used to acquire or estimate all [Infrastructure](/schema/Infrastructure) and [Management](/schema/Management) data in the Cycle. Only required if the Site contains data on [Infrastructure](/schema/Infrastructure) and [Management](/schema/Management). It can be overridden by specifying a <code>methodClassification</code> for each Infrastructure item or Management data item. <ul class="is-pl-3 is-list-style-disc"> <li>
<code>physical measurement</code> means the amount is quantified using weighing,
volume measurement, metering, chemical methods, or other physical approaches.
</li>
<li>
<code>verified survey data</code> means the data are initially collected through
surveys; all or a subset of the data are verified using physical methods; and
erroneous survey data are discarded or corrected.
</li>
<li>
<code>non-verified survey data</code> means the data are collected through
surveys that have not been subjected to verification.
</li>
<li>
<code>modelled</code> means a previously calibrated model is used to estimate
this data point from other data points describing this Cycle.
</li>
<li>
<code>estimated with assumptions</code> means a documented assumption is used
to estimate this data point from other data points describing this Cycle.
</li>
<li>
<code>consistent external sources</code> means the data are taken from external
datasets referring to different producers/enterprises:
<ul class="is-pl-4 is-list-style-disc">
<li>
Using the same technology (defined as the same
[System](/glossary?termType=system) or the same key [Practices](/schema/Practice)
as those specified in the Cycle);
</li>
<li>
At the same date (defined as occurring within the
[startDate](/schema/Cycle#startDate) and [endDate](/schema/Cycle#endDate) of the Cycle);
and
</li>
<li>
In the same [region](/schema/Site#region) or [country](/schema/Site#country).
</li>
</ul>
Modelling or assumptions may have also been used to transform these data.
</li>
<li>
<code>inconsistent external sources</code> means the data are taken from external
datasets referring to different producers/enterprises:
<ul class="is-pl-4 is-list-style-disc">
<li>
Using a different technology (defined as a different
[System](/glossary?termType=system) or using different key
[Practices](/schema/Practice) to those specified in the Cycle);
</li>
<li>
At a different date (defined as occurring within the
[startDate](/schema/Cycle#startDate) and [endDate](/schema/Cycle#endDate) of the Cycle);
or
</li>
<li>
In a different [region](/schema/Site#region) or [country](/schema/Site#country).
</li>
</ul>
Modelling or assumptions may have also been used to transform these data.
</li>
<li>
<code>expert opinion</code> means the data have been estimated by experts in
the field.
</li>
<li>
<code>unsourced assumption</code> means the data do not have a clear source
and/or are based on assumptions only.
</li>
</ul>
*/
defaultMethodClassification?: SiteDefaultMethodClassification;
/**
* A justification of the <code>[defaultMethodClassification](/schema/Site#defaultMethodClassification)</code> used. If the data were <code>estimated with assumptions</code> this field should also describe the assumptions.
*/
defaultMethodClassificationDescription?: string;
/**
* The default [Source](/schema/Source) for all data in the Site which can be overridden by specifying a source for each [Measurement](/schema/Management) or item of [Infrastructure](/schema/Infrastructure). Not required (but recommended) for public uploads (i.e., where <code>[dataPrivate](/schema/Site#dataPrivate)</code> is <code>false</code>).
*/
defaultSource?: Source;
/**
* The Measurements taken on the Site.
*/
measurements?: Measurement[];
/**
* The Management of the Site.
*/
management?: Management[];
/**
* The Infrastructure on the Site.
*/
infrastructure?: Infrastructure[];
/**
* If these data are private. Private means that HESTIA administrators can access these data and you can grant access to other platform users, but these data will not be made available to any other users of the platform or distributed to third parties.
*/
dataPrivate?: boolean;
/**
* The area in km2 of the [boundary](/schema/Site#boundary), used for validation and gap filling. This field is automatically calculated when [boundary](/schema/Site#boundary) is provided.
*/
boundaryArea?: number;
/**
* The [WWF Terrestrial Ecoregion](https://www.worldwildlife.org/publications/terrestrial-ecoregions-of-the-world) name.
*/
ecoregion?: string;
/**
* The [AWARE](http://wulca-waterlca.org/) water basin identifier.
*/
awareWaterBasinId?: string;
/**
* The identifier for these data in the source database.
*/
originalId?: string;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* A list of fields that have been added to the original dataset.
*/
added?: (string)[];
/**
* A list of versions of the model used to add these fields.
*/
addedVersion?: (string)[];
/**
* A list of fields that have been updated on the original dataset.
*/
updated?: (string)[];
/**
* A list of versions of the model used to update these fields.
*/
updatedVersion?: (string)[];
/**
* If this Site has been 'aggregated' using data from multiple Sites.
*/
aggregated?: boolean;
/**
* If this aggregated Site has been validated by the HESTIA team.
*/
aggregatedDataValidated?: boolean;
/**
* A version of the aggregation engine corresponding to this Site.
*/
aggregatedVersion?: string;
/**
* Sites used to aggregated this Site.
*/
aggregatedSites?: Site[];
/**
* Sources used to aggregated this Site.
*/
aggregatedSources?: Source[];
/**
* Date created on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
createdAt?: Date;
/**
* Last update date on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
updatedAt?: Date;
}
/**
* The area on which a Cycle occurred. Typically a field for growing crops or grazing animals, an aquaculture pond, a building, or semi-natural vegetation. Sites can also be whole farms, regions, or countries.
*/
export interface ISiteJSONLD extends JSONLD<NodeType.Site> {
/**
* A description of the Site, including information that cannot be captured with other fields.
*/
description?: string;
/**
* A reference to the [Organisation](/schema/Organisation) this Site is managed by.
*/
organisation?: IOrganisationJSONLD;
/**
* The type of the Site. Definitions for agricultural land follow [FAOSTAT](https://www.fao.org/fileadmin/templates/ess/ess_test_folder/Definitions/Land_Use_Definitions_FAOSTAT.xlsx), where cropland here means arable land and permanent crops. The additional term "glass or high accessible cover" is defined by [EUROSTAT](https://ec.europa.eu/eurostat/cache/metadata/Annexes/apro_cp_esms_an1.pdf).
*/
siteType?: SiteSiteType;
/**
* The ownership status of the Site following [EUROSTAT](https://ec.europa.eu/eurostat/statistics-explained/index.php?title=Glossary:Type_of_tenure) terminology.
*/
tenure?: SiteTenure;
/**
* If data on multiple Sites are aggregated and represented as a single Site, the number of Sites.
*/
numberOfSites?: number;
/**
* A nested [GeoJSON](https://tools.ietf.org/html/rfc7946) object for the Site boundary of type 'FeatureCollection', 'Feature' or 'GeometryCollection' in the WGS84 datum. For cropland the boundary should represent [area under cultivation](https://www.fao.org/faostat/en/#data/QCL/metadata) (also called sown area).
*/
boundary?: object;
/**
* The area of the Site in hectares. For cropland, this must be [area under cultivation](https://www.fao.org/faostat/en/#data/QCL/metadata), also called sown area. Harvested area, which can be less than sown area, can be defined for each Cycle using the field <code>[harvestedArea](/schema/Cycle#harvestedArea)</code>. If data from more than one Site has been averaged (<code>[numberOfSites](/schema/Site#numberOfSites)</code> is greater than one) the area must also be the mean area across Sites and not the sum of areas. If the Site is a country or region, the area must be the area represented by the Cycle data (e.g., the area of the sampled farms or the area of maize production in a country).
*/
area?: number;
/**
* The standard deviation of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaSd?: number;
/**
* The minimum of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaMin?: number;
/**
* The maximum of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaMax?: number;
/**
* The latitude of the centroid of the Site (-90 to 90, WGS84 datum). Latitude should be provided with at least five decimal place precision (which roughly corresponds to 1 meter precision at the equator).
*/
latitude?: number;
/**
* The longitude of the centroid of the Site (-180 to 180, WGS84 datum). Longitude should be provided with at least five decimal place precision.
*/
longitude?: number;
/**
* The country from the [Glossary](/glossary?termType=region).
*/
country?: ITermJSONLD;
/**
* The most specific geographical region from the [Glossary](/glossary?termType=region).
*/
region?: ITermJSONLD;
/**
* The [Global Location Number](https://en.wikipedia.org/wiki/Global_Location_Number).
*/
glnNumber?: string;
/**
* The date in which the Site in its current form was established in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* The date in which the Site in its current form ceased to exist in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The default classification of the method used to acquire or estimate all [Infrastructure](/schema/Infrastructure) and [Management](/schema/Management) data in the Cycle. Only required if the Site contains data on [Infrastructure](/schema/Infrastructure) and [Management](/schema/Management). It can be overridden by specifying a <code>methodClassification</code> for each Infrastructure item or Management data item. <ul class="is-pl-3 is-list-style-disc"> <li>
<code>physical measurement</code> means the amount is quantified using weighing,
volume measurement, metering, chemical methods, or other physical approaches.
</li>
<li>
<code>verified survey data</code> means the data are initially collected through
surveys; all or a subset of the data are verified using physical methods; and
erroneous survey data are discarded or corrected.
</li>
<li>
<code>non-verified survey data</code> means the data are collected through
surveys that have not been subjected to verification.
</li>
<li>
<code>modelled</code> means a previously calibrated model is used to estimate
this data point from other data points describing this Cycle.
</li>
<li>
<code>estimated with assumptions</code> means a documented assumption is used
to estimate this data point from other data points describing this Cycle.
</li>
<li>
<code>consistent external sources</code> means the data are taken from external
datasets referring to different producers/enterprises:
<ul class="is-pl-4 is-list-style-disc">
<li>
Using the same technology (defined as the same
[System](/glossary?termType=system) or the same key [Practices](/schema/Practice)
as those specified in the Cycle);
</li>
<li>
At the same date (defined as occurring within the
[startDate](/schema/Cycle#startDate) and [endDate](/schema/Cycle#endDate) of the Cycle);
and
</li>
<li>
In the same [region](/schema/Site#region) or [country](/schema/Site#country).
</li>
</ul>
Modelling or assumptions may have also been used to transform these data.
</li>
<li>
<code>inconsistent external sources</code> means the data are taken from external
datasets referring to different producers/enterprises:
<ul class="is-pl-4 is-list-style-disc">
<li>
Using a different technology (defined as a different
[System](/glossary?termType=system) or using different key
[Practices](/schema/Practice) to those specified in the Cycle);
</li>
<li>
At a different date (defined as occurring within the
[startDate](/schema/Cycle#startDate) and [endDate](/schema/Cycle#endDate) of the Cycle);
or
</li>
<li>
In a different [region](/schema/Site#region) or [country](/schema/Site#country).
</li>
</ul>
Modelling or assumptions may have also been used to transform these data.
</li>
<li>
<code>expert opinion</code> means the data have been estimated by experts in
the field.
</li>
<li>
<code>unsourced assumption</code> means the data do not have a clear source
and/or are based on assumptions only.
</li>
</ul>
*/
defaultMethodClassification?: SiteDefaultMethodClassification;
/**
* A justification of the <code>[defaultMethodClassification](/schema/Site#defaultMethodClassification)</code> used. If the data were <code>estimated with assumptions</code> this field should also describe the assumptions.
*/
defaultMethodClassificationDescription?: string;
/**
* The default [Source](/schema/Source) for all data in the Site which can be overridden by specifying a source for each [Measurement](/schema/Management) or item of [Infrastructure](/schema/Infrastructure). Not required (but recommended) for public uploads (i.e., where <code>[dataPrivate](/schema/Site#dataPrivate)</code> is <code>false</code>).
*/
defaultSource?: ISourceJSONLD;
/**
* The Measurements taken on the Site.
*/
measurements?: Measurement[];
/**
* The Management of the Site.
*/
management?: Management[];
/**
* The Infrastructure on the Site.
*/
infrastructure?: Infrastructure[];
/**
* If these data are private. Private means that HESTIA administrators can access these data and you can grant access to other platform users, but these data will not be made available to any other users of the platform or distributed to third parties.
*/
dataPrivate?: boolean;
/**
* The area in km2 of the [boundary](/schema/Site#boundary), used for validation and gap filling. This field is automatically calculated when [boundary](/schema/Site#boundary) is provided.
*/
boundaryArea?: number;
/**
* The [WWF Terrestrial Ecoregion](https://www.worldwildlife.org/publications/terrestrial-ecoregions-of-the-world) name.
*/
ecoregion?: string;
/**
* The [AWARE](http://wulca-waterlca.org/) water basin identifier.
*/
awareWaterBasinId?: string;
/**
* The identifier for these data in the source database.
*/
originalId?: string;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* A list of fields that have been added to the original dataset.
*/
added?: (string)[];
/**
* A list of versions of the model used to add these fields.
*/
addedVersion?: (string)[];
/**
* A list of fields that have been updated on the original dataset.
*/
updated?: (string)[];
/**
* A list of versions of the model used to update these fields.
*/
updatedVersion?: (string)[];
/**
* If this Site has been 'aggregated' using data from multiple Sites.
*/
aggregated?: boolean;
/**
* If this aggregated Site has been validated by the HESTIA team.
*/
aggregatedDataValidated?: boolean;
/**
* A version of the aggregation engine corresponding to this Site.
*/
aggregatedVersion?: string;
/**
* Sites used to aggregated this Site.
*/
aggregatedSites?: ISiteJSONLD[];
/**
* Sources used to aggregated this Site.
*/
aggregatedSources?: ISourceJSONLD[];
/**
* Date created on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
createdAt?: Date;
/**
* Last update date on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
updatedAt?: Date;
}
/**
* The area on which a Cycle occurred. Typically a field for growing crops or grazing animals, an aquaculture pond, a building, or semi-natural vegetation. Sites can also be whole farms, regions, or countries.
*/
export interface ISitePivoted extends JSONLD<NodeType.Site> {
/**
* A description of the Site, including information that cannot be captured with other fields.
*/
description?: string;
/**
* A reference to the [Organisation](/schema/Organisation) this Site is managed by.
*/
organisation?: Pick<IOrganisationPivoted, '@type' | '@id' | 'name'>;
/**
* The type of the Site. Definitions for agricultural land follow [FAOSTAT](https://www.fao.org/fileadmin/templates/ess/ess_test_folder/Definitions/Land_Use_Definitions_FAOSTAT.xlsx), where cropland here means arable land and permanent crops. The additional term "glass or high accessible cover" is defined by [EUROSTAT](https://ec.europa.eu/eurostat/cache/metadata/Annexes/apro_cp_esms_an1.pdf).
*/
siteType?: SiteSiteType;
/**
* The ownership status of the Site following [EUROSTAT](https://ec.europa.eu/eurostat/statistics-explained/index.php?title=Glossary:Type_of_tenure) terminology.
*/
tenure?: SiteTenure;
/**
* If data on multiple Sites are aggregated and represented as a single Site, the number of Sites.
*/
numberOfSites?: number;
/**
* A nested [GeoJSON](https://tools.ietf.org/html/rfc7946) object for the Site boundary of type 'FeatureCollection', 'Feature' or 'GeometryCollection' in the WGS84 datum. For cropland the boundary should represent [area under cultivation](https://www.fao.org/faostat/en/#data/QCL/metadata) (also called sown area).
*/
boundary?: object;
/**
* The area of the Site in hectares. For cropland, this must be [area under cultivation](https://www.fao.org/faostat/en/#data/QCL/metadata), also called sown area. Harvested area, which can be less than sown area, can be defined for each Cycle using the field <code>[harvestedArea](/schema/Cycle#harvestedArea)</code>. If data from more than one Site has been averaged (<code>[numberOfSites](/schema/Site#numberOfSites)</code> is greater than one) the area must also be the mean area across Sites and not the sum of areas. If the Site is a country or region, the area must be the area represented by the Cycle data (e.g., the area of the sampled farms or the area of maize production in a country).
*/
area?: number;
/**
* The standard deviation of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaSd?: number;
/**
* The minimum of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaMin?: number;
/**
* The maximum of <code>[area](/schema/Site#area)</code>, if there are multiple Sites.
*/
areaMax?: number;
/**
* The latitude of the centroid of the Site (-90 to 90, WGS84 datum). Latitude should be provided with at least five decimal place precision (which roughly corresponds to 1 meter precision at the equator).
*/
latitude?: number;
/**
* The longitude of the centroid of the Site (-180 to 180, WGS84 datum). Longitude should be provided with at least five decimal place precision.
*/
longitude?: number;
/**
* The country from the [Glossary](/glossary?termType=region).
*/
country?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* The most specific geographical region from the [Glossary](/glossary?termType=region).
*/
region?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* The [Global Location Number](https://en.wikipedia.org/wiki/Global_Location_Number).
*/
glnNumber?: string;
/**
* The date in which the Site in its current form was established in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* The date in which the Site in its current form ceased to exist in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The default classification of the method used to acquire or estimate all [Infrastructure](/schema/Infrastructure) and [Management](/schema/Management) data in the Cycle. Only required if the Site contains data on [Infrastructure](/schema/Infrastructure) and [Management](/schema/Management). It can be overridden by specifying a <code>methodClassification</code> for each Infrastructure item or Management data item. <ul class="is-pl-3 is-list-style-disc"> <li>
<code>physical measurement</code> means the amount is quantified using weighing,
volume measurement, metering, chemical methods, or other physical approaches.
</li>
<li>
<code>verified survey data</code> means the data are initially collected through
surveys; all or a subset of the data are verified using physical methods; and
erroneous survey data are discarded or corrected.
</li>
<li>
<code>non-verified survey data</code> means the data are collected through
surveys that have not been subjected to verification.
</li>
<li>
<code>modelled</code> means a previously calibrated model is used to estimate
this data point from other data points describing this Cycle.
</li>
<li>
<code>estimated with assumptions</code> means a documented assumption is used
to estimate this data point from other data points describing this Cycle.
</li>
<li>
<code>consistent external sources</code> means the data are taken from external
datasets referring to different producers/enterprises:
<ul class="is-pl-4 is-list-style-disc">
<li>
Using the same technology (defined as the same
[System](/glossary?termType=system) or the same key [Practices](/schema/Practice)
as those specified in the Cycle);
</li>
<li>
At the same date (defined as occurring within the
[startDate](/schema/Cycle#startDate) and [endDate](/schema/Cycle#endDate) of the Cycle);
and
</li>
<li>
In the same [region](/schema/Site#region) or [country](/schema/Site#country).
</li>
</ul>
Modelling or assumptions may have also been used to transform these data.
</li>
<li>
<code>inconsistent external sources</code> means the data are taken from external
datasets referring to different producers/enterprises:
<ul class="is-pl-4 is-list-style-disc">
<li>
Using a different technology (defined as a different
[System](/glossary?termType=system) or using different key
[Practices](/schema/Practice) to those specified in the Cycle);
</li>
<li>
At a different date (defined as occurring within the
[startDate](/schema/Cycle#startDate) and [endDate](/schema/Cycle#endDate) of the Cycle);
or
</li>
<li>
In a different [region](/schema/Site#region) or [country](/schema/Site#country).
</li>
</ul>
Modelling or assumptions may have also been used to transform these data.
</li>
<li>
<code>expert opinion</code> means the data have been estimated by experts in
the field.
</li>
<li>
<code>unsourced assumption</code> means the data do not have a clear source
and/or are based on assumptions only.
</li>
</ul>
*/
defaultMethodClassification?: SiteDefaultMethodClassification;
/**
* A justification of the <code>[defaultMethodClassification](/schema/Site#defaultMethodClassification)</code> used. If the data were <code>estimated with assumptions</code> this field should also describe the assumptions.
*/
defaultMethodClassificationDescription?: string;
/**
* The default [Source](/schema/Source) for all data in the Site which can be overridden by specifying a source for each [Measurement](/schema/Management) or item of [Infrastructure](/schema/Infrastructure). Not required (but recommended) for public uploads (i.e., where <code>[dataPrivate](/schema/Site#dataPrivate)</code> is <code>false</code>).
*/
defaultSource?: Pick<ISourcePivoted, '@type' | '@id' | 'name'>;
/**
* The Measurements taken on the Site.
*/
measurements?: {
[key: string]: {
value: number;
};
};
/**
* The Management of the Site.
*/
management?: {
[key: string]: {
value: number;
};
};
/**
* The Infrastructure on the Site.
*/
infrastructure?: {
[key: string]: {
value: number;
};
};
/**
* If these data are private. Private means that HESTIA administrators can access these data and you can grant access to other platform users, but these data will not be made available to any other users of the platform or distributed to third parties.
*/
dataPrivate?: boolean;
/**
* The area in km2 of the [boundary](/schema/Site#boundary), used for validation and gap filling. This field is automatically calculated when [boundary](/schema/Site#boundary) is provided.
*/
boundaryArea?: number;
/**
* The [WWF Terrestrial Ecoregion](https://www.worldwildlife.org/publications/terrestrial-ecoregions-of-the-world) name.
*/
ecoregion?: string;
/**
* The [AWARE](http://wulca-waterlca.org/) water basin identifier.
*/
awareWaterBasinId?: string;
/**
* The identifier for these data in the source database.
*/
originalId?: string;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* A list of fields that have been added to the original dataset.
*/
added?: (string)[];
/**
* A list of versions of the model used to add these fields.
*/
addedVersion?: (string)[];
/**
* A list of fields that have been updated on the original dataset.
*/
updated?: (string)[];
/**
* A list of versions of the model used to update these fields.
*/
updatedVersion?: (string)[];
/**
* If this Site has been 'aggregated' using data from multiple Sites.
*/
aggregated?: boolean;
/**
* If this aggregated Site has been validated by the HESTIA team.
*/
aggregatedDataValidated?: boolean;
/**
* A version of the aggregation engine corresponding to this Site.
*/
aggregatedVersion?: string;
/**
* Sites used to aggregated this Site.
*/
aggregatedSites?: Pick<ISitePivoted, '@type' | '@id' | 'name'>[];
/**
* Sources used to aggregated this Site.
*/
aggregatedSources?: Pick<ISourcePivoted, '@type' | '@id' | 'name'>[];
/**
* Date created on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
createdAt?: Date;
/**
* Last update date on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
updatedAt?: Date;
}
export declare const siteFields: string[];