@hestia-earth/schema

import { JSON, JSONLD, NodeType, SchemaType } from './types'; import { Site } from './Site'; import { Source } from './Source'; import { Completeness } from './Completeness'; import { Practice } from './Practice'; import { Animal } from './Animal'; import { Input } from './Input'; import { Product } from './Product'; import { Transformation } from './Transformation'; import { Emission } from './Emission'; import { ISiteJSONLD } from './Site'; import { ISourceJSONLD } from './Source'; import { ISitePivoted } from './Site'; import { ISourcePivoted } from './Source'; export declare enum CycleFunctionalUnit { '1 ha' = "1 ha", relative = "relative" } export declare enum CycleStartDateDefinition { 'first bearing year' = "first bearing year", 'harvest of previous crop' = "harvest of previous crop", 'one year prior' = "one year prior", 'orchard or vineyard establishment date' = "orchard or vineyard establishment date", 'soil preparation date' = "soil preparation date", 'sowing date' = "sowing date", 'start of animal life' = "start of animal life", 'start of wild harvest period' = "start of wild harvest period", 'start of year' = "start of year", 'stocking date' = "stocking date", 'transplanting date' = "transplanting date" } export declare enum CycleDefaultMethodClassification { '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 fields that make the blank nodes unique. */ export declare const cycleUniquenessFields: { practices: string[]; animals: string[]; inputs: string[]; products: string[]; transformations: string[]; emissions: string[]; }; /** * The [Inputs](/schema/Input), [Emissions](/schema/Emission), [Products](/schema/Product), and [Practices](/schema/Practice) created or used during a period. A Cycle also includes a [Completeness](/schema/Completeness) assessment, describing how complete the Inputs and Products data are, and [Transformations](/schema/Transformation), which allow Products to be transformed into new Products in the same Cycle. For animal production Cycles, the types of [Animal](/schema/Animal) present can also be specified. A Cycle occurs on a [Site](/schema/Site). */ export declare class Cycle extends JSON<SchemaType.Cycle> { /** * An automatically generated name for the Cycle composed of: primary product name, "-", <code>[site.region](/schema/Site#region)</code> "," <code>[site.country](/schema/Site#region)</code>, "-", <code>[endDate](/schema/Cycle#endDate)</code>, "-", <code>[treatment](/schema/Cycle#treatment)</code>, and/or <code>[description](/schema/Cycle#description)</code>. */ name?: string; /** * A description of the Cycle, including information that cannot be captured with other fields. */ description?: string; /** * The units that the <code>[inputs](/schema/Cycle#inputs)</code>, <code>[emissions](/schema/Cycle#emissions)</code>, <code>[products](/schema/Cycle#products)</code>, and <code>[transformations](/schema/Cycle#transformations)</code> are expressed 'per'. Can either be: <code>1 ha</code> (one hectare) or <code>relative</code> (meaning that the quantities of Inputs and Emissions correspond to the quantities of Products). If the [primary product](/schema/Product#primary) is a [crop](/glossary?termType=crop) or [forage](/glossary?termType=forage), the functional unit must be <code>1 ha</code>. */ functionalUnit?: CycleFunctionalUnit; /** * Further information on the functional unit (e.g., 'one batch'). */ functionalUnitDetails?: string; /** * The end date of the Cycle in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY). If <code>[startDate](/schema/Cycle#startDate)</code> is specified to month or day precision, <code>[endDate](/schema/Cycle#endDate)</code> must be too. For crops, <code>[endDate](/schema/Cycle#endDate)</code> must be the harvest date. For continually harvested crops, it should be the end of the year. */ endDate?: string; /** * The start date of the Cycle in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY). It is calculated as <code>endDate - cycleDuration</code>. For temporary crops, the start date should be the date of harvest of the previous crop for consistency with FAOSTAT (where a [long fallow](/term/longFallow) period is counted as a crop). For permanent crops it should be the start of the year. However other start dates can be used, such as the sowing date or soil preparation date. While the schema allows only one <code>startDate</code>, use terms from the glossary to record further information (e.g., with terms like [Cropping duration](/term/croppingDuration)). */ startDate?: string; /** * A definition of what the start date is. This is a required field if <code>[startDate](/schema/Cycle#startDate)</code> or <code>[cycleDuration](/schema/Cycle#cycleDuration)</code> are provided. */ startDateDefinition?: CycleStartDateDefinition; /** * The duration of the Cycle in days, equal to <code>endDate - startDate</code>. For crop production Cycles, this should generally be 365 days or less, but to account for short fallows before the main production Cycle it can be longer, but must be 730 days or less. */ cycleDuration?: number; /** * A reference to the [Site](/schema/Site) where this Cycle occurred. */ site?: Site; /** * If the Cycle occurred on multiple [Sites](/schema/Site), a list of the other Sites. */ otherSites?: Site[]; /** * The duration the [Site](/schema/Cycle#site) is used for this Cycle in days. For temporary crops, the use period is defined as including the short fallow period and is therefore the period from harvest of the previous crop to harvest of the current crop (<code>siteDuration</code> = <code>[cycleDuration](/schema/Cycle#cycleDuration)</code> when <code>[startDateDefinition](/schema/Cycle#startDateDefinition)</code> = <code>harvest of previous crop</code>). For permanent crops, the use period is equal to the <code>[cycleDuration](/schema/Cycle#cycleDuration)</code>. For animal production Cycles, this should be the time the animals are physically present on the Site and <code>[siteUnusedDuration](/schema/Cycle#siteUnusedDuration)</code> should be used to record periods where the Site is un-grazed, fallow, or unused. */ siteDuration?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the number of days on each Site. */ otherSitesDuration?: (number | null)[]; /** * During a Cycle, or over a number of Cycles, Sites are often unused for production for a period of time (e.g., the [long fallow duration](/term/longFallowDuration) in crop production systems or periods when animals have been rotated to a different field). The unused duration is included in land occupation calculations. For cropping Cycles, <code>siteUnusedDuration</code> is calculated as the [long fallow duration](/term/longFallowDuration) divided by the [rotation duration](/term/rotationDuration) multiplied by the <code>siteDuration</code>. It is therefore a time weighted allocation of the long fallow period to each Cycle in the crop rotation. For animal production Cycles, it is the period when animals are not present on the Site (e.g., if animals spend half the year in housing and half the year on pasture) it would be calculated <code>365/2</code> days. For animal production Cycles, if there are no other uses of a Site, it can simply be calculated as <code>cycleDuration - siteDuration</code> for each Site. For aquaculture production Cycles, it is the time between previous harvest and the current stocking (see [Fallow period (aquaculture)](fallowPeriodAquaculture)). */ siteUnusedDuration?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the number of days the Site was unused for. */ otherSitesUnusedDuration?: (number | null)[]; /** * The [area](/schema/Site#area) of the [site](/schema/Cycle#site) in hectares per <code>[functionalUnit](/schema/Cycle#functionalUnit)</code>. If the <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> is <code>1 ha</code>, this will default to <code>1</code>. If the <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> is <code>relative</code> this is the area of [site](/schema/Cycle#site) required to produce the <code>[products](/schema/Cycle#products)</code> from this Cycle. 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 using the field <code>[harvestedArea](/schema/Cycle#harvestedArea)</code>. */ siteArea?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the area of each of each of the other Sites, in hectares, required to produce the <code>[products](/schema/Cycle#products)</code> from this Cycle. */ otherSitesArea?: (number | null)[]; /** * For crops, the area harvested per <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> of this Cycle in hectares. Area harvested is the same as [area under cultivation](/schema/Site#area) if the entire cultivated area is harvested, but less if crops fail or are not harvested for economic or other reasons. */ harvestedArea?: number; /** * If data on multiple Cycles are aggregated and represented as a single Cycle, the number of Cycles. For example, Cycles occurred on the same Site in multiple growing seasons might be represented as a single Cycle with standard deviations across Cycles. */ numberOfCycles?: number; /** * A description of the treatment administered by researchers to the experimental unit. Use the <code>[numberOfReplications](/schema/Cycle#numberOfReplications)</code> field to specify the number of replicates for each treatment. */ treatment?: string; /** * Whether this treatment is representative of typical commercial practice. Required if <code>[treatment](/schema/Cycle#treatment)</code> is specified. */ commercialPracticeTreatment?: boolean; /** * In experimental studies, the number of replicates for the <code>[treatment](/schema/Cycle#treatment)</code>. */ numberOfReplications?: number; /** * In surveys, the sample weight for this Cycle relative to all other Cycles included in the [Source](/schema/Source). */ sampleWeight?: number; /** * The default classification of the method used to acquire or estimate all [Input](/schema/Input), [Product](/schema/Product), [Practice](/schema/Practice), and [Transport](/schema/Transport) data in the Cycle. It can be overridden by specifying a <code>methodClassification</code> for each Input, Product, Practice, or Transport stage. <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?: CycleDefaultMethodClassification; /** * A justification of the <code>[defaultMethodClassification](/schema/Cycle#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 Cycle which can be overridden by specifying a source for each [Input](/schema/Input), [Emission](/schema/Emission), [Product](/schema/Product), or [Practice](/schema/Practice). Required for public uploads (i.e., where <code>[dataPrivate](/schema/Cycle#dataPrivate)</code> is <code>false</code>). */ defaultSource?: Source; /** * A specification of how complete the <code>[inputs](/schema/Cycle#inputs)</code> and <code>[products](/schema/Cycle#products)</code> data are. If an area of activity data is marked as complete, then the associated Inputs and Products represent a complete description of the Cycle. */ completeness?: Completeness; /** * The Practices used. */ practices?: Practice[]; /** * The types of Animal present. */ animals?: Animal[]; /** * The Inputs used. */ inputs?: Input[]; /** * The Products created. */ products?: Product[]; /** * The Transformations applied to <code>[products](/schema/Cycle#products)</code> generated from this Cycle. */ transformations?: Transformation[]; /** * The Emissions created. */ emissions?: Emission[]; /** * 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 identifier for these data in the source database (e.g., if the data were converted from openLCA or ecoinvent, the id field from that 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 Cycle has been 'aggregated' using data from multiple Cycles. */ aggregated?: boolean; /** * If this aggregated Cycle has been validated by the HESTIA team. */ aggregatedDataValidated?: boolean; /** * A version of the aggregation engine corresponding to this Cycle. */ aggregatedVersion?: string; /** * A data quality score for aggregated data. The points depend on the primary [Product](/schema/Cycle#product) of the aggregation. One point is awarded for each of the categories satisfied, according to the table below. For global aggregations, an additional point is awarded for both farm-stage and processing aggregations if the aggregation includes countries representing over 75% of production of the farm-gate product. The global aggregation is then scored out of 4 or 5 for processing and crop respectively. | Primary Product | Emissions | Number of Cycles | Yield | Completeness | | --- | --- | --- | --- | --- | | Crop | No emissions included in the system boundary are missing | Over 50 Cycles | Within +/- 20% of FAOSTAT yield for the primary Product | True for all priority areas (animalFeed, cropResidue, electricityFuel, excreta, fertiliser, freshForage, ingredient, liveAnimalInput, otherChemical, pesticdieVetinaryDrug, product, seed, water) | | Processed food | No emissions included in the system boundary are missing | Over 10 Cycles | - | True for all priority areas True for all priority areas (electricityFuel, ingredient, product, water) | */ aggregatedQualityScore?: number; /** * The maximum value for [the aggregated quality score](/schema/Cycle#aggregatedQualityScore). */ aggregatedQualityScoreMax?: number; /** * Cycles used to aggregated this Cycle. */ aggregatedCycles?: Cycle[]; /** * Sources used to aggregated this Cycle. */ aggregatedSources?: Source[]; /** * An array of strings which are the column column/row headers of the <code>[covarianceMatrix](/schema/Cycle#covarianceMatrix)</code>. */ covarianceMatrixIds?: (string)[]; /** * For aggregated cycles only, a covariance matrix, represented using the lower triangle only. The covariance matrix describes the covariance between all data items in the Cycle. It is used to generate the distributions of [Impact Assessment](/schema/ImpactAssessment) [Indicators](/schema/Indicator). E.g., it contains the covariance between one emission and another. It controls for the fact that data items in the [Cycle](/schema/Cycle) often covary with another. This covariance generally reduces the variability in the distributions of Indicators. */ covarianceMatrix?: number | null[][]; /** * 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 [Inputs](/schema/Input), [Emissions](/schema/Emission), [Products](/schema/Product), and [Practices](/schema/Practice) created or used during a period. A Cycle also includes a [Completeness](/schema/Completeness) assessment, describing how complete the Inputs and Products data are, and [Transformations](/schema/Transformation), which allow Products to be transformed into new Products in the same Cycle. For animal production Cycles, the types of [Animal](/schema/Animal) present can also be specified. A Cycle occurs on a [Site](/schema/Site). */ export interface ICycleJSONLD extends JSONLD<NodeType.Cycle> { /** * A description of the Cycle, including information that cannot be captured with other fields. */ description?: string; /** * The units that the <code>[inputs](/schema/Cycle#inputs)</code>, <code>[emissions](/schema/Cycle#emissions)</code>, <code>[products](/schema/Cycle#products)</code>, and <code>[transformations](/schema/Cycle#transformations)</code> are expressed 'per'. Can either be: <code>1 ha</code> (one hectare) or <code>relative</code> (meaning that the quantities of Inputs and Emissions correspond to the quantities of Products). If the [primary product](/schema/Product#primary) is a [crop](/glossary?termType=crop) or [forage](/glossary?termType=forage), the functional unit must be <code>1 ha</code>. */ functionalUnit?: CycleFunctionalUnit; /** * Further information on the functional unit (e.g., 'one batch'). */ functionalUnitDetails?: string; /** * The end date of the Cycle in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY). If <code>[startDate](/schema/Cycle#startDate)</code> is specified to month or day precision, <code>[endDate](/schema/Cycle#endDate)</code> must be too. For crops, <code>[endDate](/schema/Cycle#endDate)</code> must be the harvest date. For continually harvested crops, it should be the end of the year. */ endDate?: string; /** * The start date of the Cycle in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY). It is calculated as <code>endDate - cycleDuration</code>. For temporary crops, the start date should be the date of harvest of the previous crop for consistency with FAOSTAT (where a [long fallow](/term/longFallow) period is counted as a crop). For permanent crops it should be the start of the year. However other start dates can be used, such as the sowing date or soil preparation date. While the schema allows only one <code>startDate</code>, use terms from the glossary to record further information (e.g., with terms like [Cropping duration](/term/croppingDuration)). */ startDate?: string; /** * A definition of what the start date is. This is a required field if <code>[startDate](/schema/Cycle#startDate)</code> or <code>[cycleDuration](/schema/Cycle#cycleDuration)</code> are provided. */ startDateDefinition?: CycleStartDateDefinition; /** * The duration of the Cycle in days, equal to <code>endDate - startDate</code>. For crop production Cycles, this should generally be 365 days or less, but to account for short fallows before the main production Cycle it can be longer, but must be 730 days or less. */ cycleDuration?: number; /** * A reference to the [Site](/schema/Site) where this Cycle occurred. */ site?: ISiteJSONLD; /** * If the Cycle occurred on multiple [Sites](/schema/Site), a list of the other Sites. */ otherSites?: ISiteJSONLD[]; /** * The duration the [Site](/schema/Cycle#site) is used for this Cycle in days. For temporary crops, the use period is defined as including the short fallow period and is therefore the period from harvest of the previous crop to harvest of the current crop (<code>siteDuration</code> = <code>[cycleDuration](/schema/Cycle#cycleDuration)</code> when <code>[startDateDefinition](/schema/Cycle#startDateDefinition)</code> = <code>harvest of previous crop</code>). For permanent crops, the use period is equal to the <code>[cycleDuration](/schema/Cycle#cycleDuration)</code>. For animal production Cycles, this should be the time the animals are physically present on the Site and <code>[siteUnusedDuration](/schema/Cycle#siteUnusedDuration)</code> should be used to record periods where the Site is un-grazed, fallow, or unused. */ siteDuration?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the number of days on each Site. */ otherSitesDuration?: (number | null)[]; /** * During a Cycle, or over a number of Cycles, Sites are often unused for production for a period of time (e.g., the [long fallow duration](/term/longFallowDuration) in crop production systems or periods when animals have been rotated to a different field). The unused duration is included in land occupation calculations. For cropping Cycles, <code>siteUnusedDuration</code> is calculated as the [long fallow duration](/term/longFallowDuration) divided by the [rotation duration](/term/rotationDuration) multiplied by the <code>siteDuration</code>. It is therefore a time weighted allocation of the long fallow period to each Cycle in the crop rotation. For animal production Cycles, it is the period when animals are not present on the Site (e.g., if animals spend half the year in housing and half the year on pasture) it would be calculated <code>365/2</code> days. For animal production Cycles, if there are no other uses of a Site, it can simply be calculated as <code>cycleDuration - siteDuration</code> for each Site. For aquaculture production Cycles, it is the time between previous harvest and the current stocking (see [Fallow period (aquaculture)](fallowPeriodAquaculture)). */ siteUnusedDuration?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the number of days the Site was unused for. */ otherSitesUnusedDuration?: (number | null)[]; /** * The [area](/schema/Site#area) of the [site](/schema/Cycle#site) in hectares per <code>[functionalUnit](/schema/Cycle#functionalUnit)</code>. If the <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> is <code>1 ha</code>, this will default to <code>1</code>. If the <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> is <code>relative</code> this is the area of [site](/schema/Cycle#site) required to produce the <code>[products](/schema/Cycle#products)</code> from this Cycle. 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 using the field <code>[harvestedArea](/schema/Cycle#harvestedArea)</code>. */ siteArea?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the area of each of each of the other Sites, in hectares, required to produce the <code>[products](/schema/Cycle#products)</code> from this Cycle. */ otherSitesArea?: (number | null)[]; /** * For crops, the area harvested per <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> of this Cycle in hectares. Area harvested is the same as [area under cultivation](/schema/Site#area) if the entire cultivated area is harvested, but less if crops fail or are not harvested for economic or other reasons. */ harvestedArea?: number; /** * If data on multiple Cycles are aggregated and represented as a single Cycle, the number of Cycles. For example, Cycles occurred on the same Site in multiple growing seasons might be represented as a single Cycle with standard deviations across Cycles. */ numberOfCycles?: number; /** * A description of the treatment administered by researchers to the experimental unit. Use the <code>[numberOfReplications](/schema/Cycle#numberOfReplications)</code> field to specify the number of replicates for each treatment. */ treatment?: string; /** * Whether this treatment is representative of typical commercial practice. Required if <code>[treatment](/schema/Cycle#treatment)</code> is specified. */ commercialPracticeTreatment?: boolean; /** * In experimental studies, the number of replicates for the <code>[treatment](/schema/Cycle#treatment)</code>. */ numberOfReplications?: number; /** * In surveys, the sample weight for this Cycle relative to all other Cycles included in the [Source](/schema/Source). */ sampleWeight?: number; /** * The default classification of the method used to acquire or estimate all [Input](/schema/Input), [Product](/schema/Product), [Practice](/schema/Practice), and [Transport](/schema/Transport) data in the Cycle. It can be overridden by specifying a <code>methodClassification</code> for each Input, Product, Practice, or Transport stage. <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?: CycleDefaultMethodClassification; /** * A justification of the <code>[defaultMethodClassification](/schema/Cycle#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 Cycle which can be overridden by specifying a source for each [Input](/schema/Input), [Emission](/schema/Emission), [Product](/schema/Product), or [Practice](/schema/Practice). Required for public uploads (i.e., where <code>[dataPrivate](/schema/Cycle#dataPrivate)</code> is <code>false</code>). */ defaultSource?: ISourceJSONLD; /** * A specification of how complete the <code>[inputs](/schema/Cycle#inputs)</code> and <code>[products](/schema/Cycle#products)</code> data are. If an area of activity data is marked as complete, then the associated Inputs and Products represent a complete description of the Cycle. */ completeness?: Completeness; /** * The Practices used. */ practices?: Practice[]; /** * The types of Animal present. */ animals?: Animal[]; /** * The Inputs used. */ inputs?: Input[]; /** * The Products created. */ products?: Product[]; /** * The Transformations applied to <code>[products](/schema/Cycle#products)</code> generated from this Cycle. */ transformations?: Transformation[]; /** * The Emissions created. */ emissions?: Emission[]; /** * 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 identifier for these data in the source database (e.g., if the data were converted from openLCA or ecoinvent, the id field from that 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 Cycle has been 'aggregated' using data from multiple Cycles. */ aggregated?: boolean; /** * If this aggregated Cycle has been validated by the HESTIA team. */ aggregatedDataValidated?: boolean; /** * A version of the aggregation engine corresponding to this Cycle. */ aggregatedVersion?: string; /** * A data quality score for aggregated data. The points depend on the primary [Product](/schema/Cycle#product) of the aggregation. One point is awarded for each of the categories satisfied, according to the table below. For global aggregations, an additional point is awarded for both farm-stage and processing aggregations if the aggregation includes countries representing over 75% of production of the farm-gate product. The global aggregation is then scored out of 4 or 5 for processing and crop respectively. | Primary Product | Emissions | Number of Cycles | Yield | Completeness | | --- | --- | --- | --- | --- | | Crop | No emissions included in the system boundary are missing | Over 50 Cycles | Within +/- 20% of FAOSTAT yield for the primary Product | True for all priority areas (animalFeed, cropResidue, electricityFuel, excreta, fertiliser, freshForage, ingredient, liveAnimalInput, otherChemical, pesticdieVetinaryDrug, product, seed, water) | | Processed food | No emissions included in the system boundary are missing | Over 10 Cycles | - | True for all priority areas True for all priority areas (electricityFuel, ingredient, product, water) | */ aggregatedQualityScore?: number; /** * The maximum value for [the aggregated quality score](/schema/Cycle#aggregatedQualityScore). */ aggregatedQualityScoreMax?: number; /** * Cycles used to aggregated this Cycle. */ aggregatedCycles?: ICycleJSONLD[]; /** * Sources used to aggregated this Cycle. */ aggregatedSources?: ISourceJSONLD[]; /** * An array of strings which are the column column/row headers of the <code>[covarianceMatrix](/schema/Cycle#covarianceMatrix)</code>. */ covarianceMatrixIds?: (string)[]; /** * For aggregated cycles only, a covariance matrix, represented using the lower triangle only. The covariance matrix describes the covariance between all data items in the Cycle. It is used to generate the distributions of [Impact Assessment](/schema/ImpactAssessment) [Indicators](/schema/Indicator). E.g., it contains the covariance between one emission and another. It controls for the fact that data items in the [Cycle](/schema/Cycle) often covary with another. This covariance generally reduces the variability in the distributions of Indicators. */ covarianceMatrix?: number | null[][]; /** * 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 [Inputs](/schema/Input), [Emissions](/schema/Emission), [Products](/schema/Product), and [Practices](/schema/Practice) created or used during a period. A Cycle also includes a [Completeness](/schema/Completeness) assessment, describing how complete the Inputs and Products data are, and [Transformations](/schema/Transformation), which allow Products to be transformed into new Products in the same Cycle. For animal production Cycles, the types of [Animal](/schema/Animal) present can also be specified. A Cycle occurs on a [Site](/schema/Site). */ export interface ICyclePivoted extends JSONLD<NodeType.Cycle> { /** * A description of the Cycle, including information that cannot be captured with other fields. */ description?: string; /** * The units that the <code>[inputs](/schema/Cycle#inputs)</code>, <code>[emissions](/schema/Cycle#emissions)</code>, <code>[products](/schema/Cycle#products)</code>, and <code>[transformations](/schema/Cycle#transformations)</code> are expressed 'per'. Can either be: <code>1 ha</code> (one hectare) or <code>relative</code> (meaning that the quantities of Inputs and Emissions correspond to the quantities of Products). If the [primary product](/schema/Product#primary) is a [crop](/glossary?termType=crop) or [forage](/glossary?termType=forage), the functional unit must be <code>1 ha</code>. */ functionalUnit?: CycleFunctionalUnit; /** * Further information on the functional unit (e.g., 'one batch'). */ functionalUnitDetails?: string; /** * The end date of the Cycle in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY). If <code>[startDate](/schema/Cycle#startDate)</code> is specified to month or day precision, <code>[endDate](/schema/Cycle#endDate)</code> must be too. For crops, <code>[endDate](/schema/Cycle#endDate)</code> must be the harvest date. For continually harvested crops, it should be the end of the year. */ endDate?: string; /** * The start date of the Cycle in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY). It is calculated as <code>endDate - cycleDuration</code>. For temporary crops, the start date should be the date of harvest of the previous crop for consistency with FAOSTAT (where a [long fallow](/term/longFallow) period is counted as a crop). For permanent crops it should be the start of the year. However other start dates can be used, such as the sowing date or soil preparation date. While the schema allows only one <code>startDate</code>, use terms from the glossary to record further information (e.g., with terms like [Cropping duration](/term/croppingDuration)). */ startDate?: string; /** * A definition of what the start date is. This is a required field if <code>[startDate](/schema/Cycle#startDate)</code> or <code>[cycleDuration](/schema/Cycle#cycleDuration)</code> are provided. */ startDateDefinition?: CycleStartDateDefinition; /** * The duration of the Cycle in days, equal to <code>endDate - startDate</code>. For crop production Cycles, this should generally be 365 days or less, but to account for short fallows before the main production Cycle it can be longer, but must be 730 days or less. */ cycleDuration?: number; /** * A reference to the [Site](/schema/Site) where this Cycle occurred. */ site?: Pick<ISitePivoted, '@type' | '@id' | 'name'>; /** * If the Cycle occurred on multiple [Sites](/schema/Site), a list of the other Sites. */ otherSites?: Pick<ISitePivoted, '@type' | '@id' | 'name'>[]; /** * The duration the [Site](/schema/Cycle#site) is used for this Cycle in days. For temporary crops, the use period is defined as including the short fallow period and is therefore the period from harvest of the previous crop to harvest of the current crop (<code>siteDuration</code> = <code>[cycleDuration](/schema/Cycle#cycleDuration)</code> when <code>[startDateDefinition](/schema/Cycle#startDateDefinition)</code> = <code>harvest of previous crop</code>). For permanent crops, the use period is equal to the <code>[cycleDuration](/schema/Cycle#cycleDuration)</code>. For animal production Cycles, this should be the time the animals are physically present on the Site and <code>[siteUnusedDuration](/schema/Cycle#siteUnusedDuration)</code> should be used to record periods where the Site is un-grazed, fallow, or unused. */ siteDuration?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the number of days on each Site. */ otherSitesDuration?: (number | null)[]; /** * During a Cycle, or over a number of Cycles, Sites are often unused for production for a period of time (e.g., the [long fallow duration](/term/longFallowDuration) in crop production systems or periods when animals have been rotated to a different field). The unused duration is included in land occupation calculations. For cropping Cycles, <code>siteUnusedDuration</code> is calculated as the [long fallow duration](/term/longFallowDuration) divided by the [rotation duration](/term/rotationDuration) multiplied by the <code>siteDuration</code>. It is therefore a time weighted allocation of the long fallow period to each Cycle in the crop rotation. For animal production Cycles, it is the period when animals are not present on the Site (e.g., if animals spend half the year in housing and half the year on pasture) it would be calculated <code>365/2</code> days. For animal production Cycles, if there are no other uses of a Site, it can simply be calculated as <code>cycleDuration - siteDuration</code> for each Site. For aquaculture production Cycles, it is the time between previous harvest and the current stocking (see [Fallow period (aquaculture)](fallowPeriodAquaculture)). */ siteUnusedDuration?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the number of days the Site was unused for. */ otherSitesUnusedDuration?: (number | null)[]; /** * The [area](/schema/Site#area) of the [site](/schema/Cycle#site) in hectares per <code>[functionalUnit](/schema/Cycle#functionalUnit)</code>. If the <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> is <code>1 ha</code>, this will default to <code>1</code>. If the <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> is <code>relative</code> this is the area of [site](/schema/Cycle#site) required to produce the <code>[products](/schema/Cycle#products)</code> from this Cycle. 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 using the field <code>[harvestedArea](/schema/Cycle#harvestedArea)</code>. */ siteArea?: number; /** * If a Cycle occurred on multiple [Sites](/schema/Site), a corresponding array to <code>[otherSites](/schema/Cycle#otherSites)</code> with the area of each of each of the other Sites, in hectares, required to produce the <code>[products](/schema/Cycle#products)</code> from this Cycle. */ otherSitesArea?: (number | null)[]; /** * For crops, the area harvested per <code>[functionalUnit](/schema/Cycle#functionalUnit)</code> of this Cycle in hectares. Area harvested is the same as [area under cultivation](/schema/Site#area) if the entire cultivated area is harvested, but less if crops fail or are not harvested for economic or other reasons. */ harvestedArea?: number; /** * If data on multiple Cycles are aggregated and represented as a single Cycle, the number of Cycles. For example, Cycles occurred on the same Site in multiple growing seasons might be represented as a single Cycle with standard deviations across Cycles. */ numberOfCycles?: number; /** * A description of the treatment administered by researchers to the experimental unit. Use the <code>[numberOfReplications](/schema/Cycle#numberOfReplications)</code> field to specify the number of replicates for each treatment. */ treatment?: string; /** * Whether this treatment is representative of typical commercial practice. Required if <code>[treatment](/schema/Cycle#treatment)</code> is specified. */ commercialPracticeTreatment?: boolean; /** * In experimental studies, the number of replicates for the <code>[treatment](/schema/Cycle#treatment)</code>. */ numberOfReplications?: number; /** * In surveys, the sample weight for this Cycle relative to all other Cycles included in the [Source](/schema/Source). */ sampleWeight?: number; /** * The default classification of the method used to acquire or estimate all [Input](/schema/Input), [Product](/schema/Product), [Practice](/schema/Practice), and [Transport](/schema/Transport) data in the Cycle. It can be overridden by specifying a <code>methodClassification</code> for each Input, Product, Practice, or Transport stage. <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> <