Cycle>Input

Input

Type:Blank Node

View examples

An Input used during the Cycle or Transformation. Each Input must be unique, and the fields which determine uniqueness are defined in the inputs field of the Cycle or Transformation.

FieldTypeRequiredDefinition
term
TermYes

A reference to the Term describing the Input.

This field has additional validation rules when set:

  • the term.termType must have one of the following values: biologicalControlAgent, electricity, feedFoodAdditive, fuel, material, inorganicFertiliser, organicFertiliser, fertiliserBrandName, biochar, pesticideAI, pesticideBrandName, processingAid, seed, otherOrganicChemical, otherInorganicChemical, soilAmendment, substrate, water, animalProduct, crop, aquaticCrop, forage, liveAnimal, liveAquaticSpecies, excreta, processedFood, veterinaryDrug, waste.

description
stringNo

A description of the Input.

value
array[number|null]No

The quantity of the Input. If an average, it should always be the mean. Can be a single number (array of length one) or an array of numbers with associated dates (e.g., representing an application schedule).

distribution
array[number]|array[array[number]]No

An array of up to 1000 random samples from the posterior distribution of valuedates field.

sd
array[number|null]No

The standard deviation of value.

This field has additional validation rules when set:

  • statsDefinition must also be set.

min
array[number|null]No

The minimum of value.

This field has additional validation rules when set:

  • statsDefinition must also be set.

max
array[number|null]No

The maximum of value.

This field has additional validation rules when set:

  • statsDefinition must also be set.

statsDefinition
stringNo

What the descriptive statistics (sd, min, max, and value) are calculated across, or whether they are simulated or the output of a model. spatial refers to descriptive statistics calculated across spatial units (e.g., pixels) within a region or country. time refers to descriptive statistics calculated across units of time (e.g., hours).

Possible values are: sites, cycles, replications, animals, other observations, time, spatial, regions, simulated, modelled

This field has additional validation rules when set:

  • one of the following must be valid:
    • value must also be set.
    • min must also be set.
    • max must also be set.
    • sd must also be set.

observations
array[number|null]No

The number of observations the descriptive statistics are calculated over.

dates
array[string]No

A corresponding array to value, representing the dates of the Inputs in ISO 8601 format (YYYY-MM-DD, YYYY-MM, YYYY, --MM-DD, --MM, or YYYY-MM-DDTHH:mm:ssZ).

startDate
stringNo

For Inputs over periods different to Cycle, the start date of the Input (if different from the start date of the Cycle format (YYYY-MM-DD).

endDate
stringNo

For Inputs over periods different to Cycle, the end date of the Input (if different from the end date of the Cycle format (YYYY-MM-DD).

inputDuration
numberNo

The duration of the Input in days.

methodClassification
stringNo

A classification of the method used to acquire or estimate the term and value. Overrides the defaultMethodClassification specified in the Cycle. methodClassification should be specified separately for properties (see Property) and transport (see Transport).

  • physical measurement means the amount is quantified using weighing, volume measurement, metering, chemical methods, or other physical approaches.
  • verified survey data 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.
  • non-verified survey data means the data are collected through surveys that have not been subjected to verification.
  • modelled means a previously calibrated model is used to estimate this data point from other data points describing this Cycle.
  • estimated with assumptions means a documented assumption is used to estimate this data point from other data points describing this Cycle.
  • consistent external sources means the data are taken from external datasets referring to different producers/enterprises:
    • Using the same technology (defined as the same System or the same key Practices as those specified in the Cycle);
    • At the same date (defined as occurring within the startDate and endDate of the Cycle); and
    • In the same region or country.
    Modelling or assumptions may have also been used to transform these data.
  • inconsistent external sources means the data are taken from external datasets referring to different producers/enterprises:
    • Using a different technology (defined as a different System or using different key Practices to those specified in the Cycle);
    • At a different date (defined as occurring within the startDate and endDate of the Cycle); or
    • In a different region or country.
    Modelling or assumptions may have also been used to transform these data.
  • expert opinion means the data have been estimated by experts in the field.
  • unsourced assumption means the data do not have a clear source and/or are based on assumptions only.

Possible values are: physical measurement, verified survey data, non-verified survey data, modelled, estimated with assumptions, consistent external sources, inconsistent external sources, expert opinion, unsourced assumption

This field has additional validation rules when set:

  • methodClassificationDescription must also be set.

methodClassificationDescription
stringNo

A justification of the methodClassification used. If the data were estimated with assumptions this field should also describe the assumptions. This is a required field if methodClassification is specified.

model
TermNo

A reference to the Term describing the model used to estimate these data.

This field has additional validation rules when set:

  • the model.termType must have one of the following values: model.

modelDescription
stringNo

A free text field, describing the model used to estimate these data.

isAnimalFeed
booleanNo

true if this Input is fed to animals. A required field for Inputs which could potentially be animal feed (defined as Inputs of termType = crop, aquaticCrop, forage, liveAnimal, animalProduct, liveAquaticSpecies, feedFoodAdditive, processedFood, or waste in animal production Cycles).

variety
stringNo

The variety (cultivar) of a crop or breed of animal. Standardised variety names are defined in external glossaries, such as the OECD, GEVES, PLUTO, or CPVO glossaries.

fate
stringNo

The fate of the Input. This field can be used for Inputs into Transformations only, to univocally match the Input with the Cycle Product.

Possible values are: sold, sold to export market, sold to domestic market, sold for breeding, sold for fattening, sold for slaughter, home consumption, fodder, bedding, breeding, saved for seeds, processing, burnt for fuel, burnt, anaerobic digestion, composted, used as fertiliser, used as soil amendment, used as mulch

fromCycle
booleanNo

A required field for Inputs into Transformations only. true if this Input is a Product from the Cycle. false if this Input was added at the Transformation stage only (e.g., diesel used to power a grain dryer) or false if this Input is a Product from a previous Transformation.

producedInCycle
booleanNo

Whether an input is produced and used during the Cycle, e.g., true if the forage is grown on the pasture where animals are grazing, false if it is grown elsewhere.

price
numberNo

The price paid for this Input. The currency must be specified. The price should be expressed per the units defined in the term, for example per "kg active ingredient". In situations where a term describes one physical item (e.g., "NP Blend" fertiliser) but the glossary uses terms with unit that split the item (e.g., "NP Blend (kg N)" and "NP Blend (kg P2O5)") the price must be divided by the relative mass of each term.

This field has additional validation rules when set:

  • currency must also be set.

priceSd
numberNo

The standard deviation of price.

This field has additional validation rules when set:

  • priceStatsDefinition must also be set.

priceMin
numberNo

The minimum of price.

This field has additional validation rules when set:

  • priceStatsDefinition must also be set.

priceMax
numberNo

The maximum of price.

This field has additional validation rules when set:

  • priceStatsDefinition must also be set.

priceStatsDefinition
stringNo

What the descriptive statistics for price are calculated across.

Possible values are: cycles, time, cycles and time

cost
numberNo

The total cost of this Input (price x quantity), expressed as a positive value. The currency must be specified.

This field has additional validation rules when set:

  • currency must also be set.

costSd
numberNo

The standard deviation of cost.

This field has additional validation rules when set:

  • costStatsDefinition must also be set.

costMin
numberNo

The minimum of cost.

This field has additional validation rules when set:

  • costStatsDefinition must also be set.

costMax
numberNo

The maximum of cost.

This field has additional validation rules when set:

  • costStatsDefinition must also be set.

costStatsDefinition
stringNo

What the descriptive statistics for cost are calculated across.

Possible values are: cycles, time, cycles and time

currency
stringNo

The three letter currency code in ISO 4217 format.

lifespan
numberNo

For Inputs used to create Infrastructure, the lifespan of this Input expressed in decimal years.

operation
TermNo

A reference to the Term describing the operation associated with this Input (e.g., for the Input diesel the operation could be Soil decompaction, machine unspecified).

This field has additional validation rules when set:

  • the operation.termType must have one of the following values: operation.

country
TermNo

The country where this Input came from.

This field has additional validation rules when set:

  • the country.termType must have one of the following values: region.

region
TermNo

The region where this Input came from.

This field has additional validation rules when set:

  • the region.termType must have one of the following values: region.
  • country must also be set.

impactAssessment
ImpactAssessmentNo

A reference to the node containing environmental impact data related to producing this product and transporting it to the Site.

This field has additional validation rules when set:

  • impactAssessmentIsProxy must also be set.

impactAssessmentIsProxy
booleanNo

The impactAssessment referred to represents data from the actual supply chain (e.g., data from the actual supplying farm or the supplying feed mill). Set to false
The impactAssessment referred to is a proxy for the actual supply chain (e.g., global or regional average data). Set to true

Required if impactAssessment is specified.

site
SiteNo

If the Cycle occurred on multiple Sites, the Site where this Input was used.

source
SourceNo

A reference to the Source of these data, if different from the defaultSource of the Cycle.

otherSources
List[Source]No

A list of references to any other sources of these data.

properties
List[Property]No

A list of Properties of the Input, which would override any default properties specified in the term.

properties cannot be duplicated. The following fields determine whether a Property is unique: term.@id, key.@id, value, share, date, startDate, endDate

transport
List[Transport]No

A list of Transport stages to bring this Input to the Cycle.

transport cannot be duplicated. The following fields determine whether a Transport is unique: term.@id, value, distance

Internal Properties

The following properties are automatically set when data are uploaded to the HESTIA platform. If they are included in a file which is uploaded, they will be overwritten.

FieldTypeDefinition
@context

The location of the JSON-LD context file.

@id

The unique ID assigned to the Node by HESTIA.

@type

Input

percentile10th
number

The 10th percentile of value.

percentile90th
number

The 90th percentile of value.

schemaVersion
string

The version of the schema when these data were created.

added
array[string]

A list of fields that have been added to the original dataset.

addedVersion
array[string]

A list of versions of the model used to add these fields.

updated
array[string]

A list of fields that have been updated on the original dataset.

updatedVersion
array[string]

A list of versions of the model used to update these fields.

aggregated
array[string]

A list of fields that have been 'aggregated' using data from multiple Cycles.

aggregatedVersion
array[string]

A list of versions of the aggregation engine corresponding to each aggregated field.

Example 1

{
  "@type": "Input",
  "term": {
    "@id": "CAS-34494-04-7",
    "@type": "Term",
    "name": "Glyphosate",
    "units": "g active ingredient",
    "termType": "pesticideAI"
  },
  "value": [
    400
  ],
  "sd": [
    180
  ],
  "statsDefinition": "replications",
  "observations": [
    10
  ]
}