EnVar microschema · class
Equation Input
EquationInput
A single physical-state input to a derived heat metric, recorded as a typed reference into the provenance chain rather than an inline copy of the input's metadata. It names the input's role (a CF standard name) and points, via input_provenance_id, to the upstream sidecar that carries that input's full spatial / temporal / model context. This is the Option-B decomposition: when a multi-input metric (Heat Index from T + RH; WBGT from T + RH + wind + radiation) draws its inputs from different products that diverge in resolution, day-boundary convention, or temporal aggregation, each input remains its own full sidecar — listed here and as a step in provenance_chain — so the divergence stays explicit and machine-checkable instead of being silently absorbed into the single output value.
Where it sits
Composed intoDerivedHeatMetric
Fields
This labels what each ingredient actually is — temperature versus humidity versus wind — using a shared standard vocabulary so that machines and people read the label the same way.
The standard-name local token of this input's physical quantity (the same quantity the referenced sidecar carries in standard_name), e.g. air_temperature, relative_humidity, wind_speed, surface_downwelling_shortwave_flux_in_air.
Example
air_temperature
Why it matters & mappings
Without a named role, a consumer cannot tell which physical quantity each referenced input supplied to the equation, so inputs cannot be matched to equation terms and cross-input consistency checks cannot run.
See also: https://cfconventions.org/
Think of it as a tracking number: instead of copying all the details of the ingredient into this record, we store a pointer to the record that already holds them, and anyone can follow the pointer.
The provenance_id of the upstream sidecar that fully describes this input — its source dataset, spatial / temporal reference, and exposure model. Dereferencing it lets a consumer (or the completeness checker) compare inputs and surface any divergence in resolution, day-boundary convention, or temporal aggregation.
Example
01HFA7K8R3M6XP-daymet-tmax — provenance_id of the upstream Daymet Tmax sidecar
Why it matters & mappings
This is the only machine-followable link from an input back to its full spatial, temporal, and model context; without it, divergences between inputs in resolution, day-boundary convention, or aggregation cannot be detected at all.
See also: https://www.w3.org/TR/prov-o/
A friendly nickname for the dataset an ingredient came from (like "daymet_v4"), written next to the tracking number so people do not have to look everything up just to get oriented.
Human-readable short code of the input's source product (e.g. daymet_v4, era5), duplicated from the referenced sidecar for convenience when scanning the record. Not authoritative — input_provenance_id is.
Example
daymet_v4
Covered by — 5 standards
Why it matters & mappings
Lets a human scanning the record see at a glance which product each input came from without dereferencing every provenance id; because it is a non-authoritative duplicate, omitting it costs readability, not machine-checkability.
Full field reference — every slot, cardinality & inheritance
| Field | Name | Tier | Cardinality / Range | Description |
|---|---|---|---|---|
| Input Role | input_role |
conditionally core | 1 String |
The standard-name local token of this input's physical quantity (the same qua... |
| Input Provenance ID | input_provenance_id |
conditionally core | 1 String |
The provenance_id of the upstream sidecar that fully describes this input —... |
| Input Source Short Code | input_source_short_code |
recommended | 0..1 String |
Human-readable short code of the input's source product (e |
Diagram & LinkML source
classDiagram
class EquationInput
click EquationInput href "../../classes/EquationInput/"
EquationInput : input_provenance_id
EquationInput : input_role
EquationInput : input_source_short_code
name: EquationInput
annotations:
domain_of_use:
tag: domain_of_use
value: environmental_exposure
description: 'A single physical-state input to a derived heat metric, recorded as
a typed reference into the provenance chain rather than an inline copy of the input''s
metadata. It names the input''s role (a CF standard name) and points, via `input_provenance_id`,
to the upstream sidecar that carries that input''s full spatial / temporal / model
context.
This is the Option-B decomposition: when a multi-input metric (Heat Index from T
+ RH; WBGT from T + RH + wind + radiation) draws its inputs from different products
that diverge in resolution, day-boundary convention, or temporal aggregation, each
input remains its own full sidecar — listed here and as a step in `provenance_chain`
— so the divergence stays explicit and machine-checkable instead of being silently
absorbed into the single output value.'
title: Equation Input
from_schema: https://w3id.org/linkml/microschemas/envar
see_also:
- https://cfconventions.org/
rank: 1000
slot_usage:
input_role:
name: input_role
required: true
input_provenance_id:
name: input_provenance_id
required: true
attributes:
input_role:
name: input_role
annotations:
tier:
tag: tier
value: conditionally_core
justification:
tag: justification
value: Without a named role, a consumer cannot tell which physical quantity
each referenced input supplied to the equation, so inputs cannot be matched
to equation terms and cross-input consistency checks cannot run.
explanation:
tag: explanation
value: This labels what each ingredient actually is — temperature versus humidity
versus wind — using a shared standard vocabulary so that machines and people
read the label the same way.
description: The standard-name local token of this input's physical quantity (the
same quantity the referenced sidecar carries in `standard_name`), e.g. `air_temperature`,
`relative_humidity`, `wind_speed`, `surface_downwelling_shortwave_flux_in_air`.
title: Input Role
examples:
- value: air_temperature
from_schema: https://w3id.org/linkml/microschemas/envar
see_also:
- https://cfconventions.org/
rank: 1000
owner: EquationInput
domain_of:
- EquationInput
range: string
required: true
input_provenance_id:
name: input_provenance_id
annotations:
tier:
tag: tier
value: conditionally_core
justification:
tag: justification
value: This is the only machine-followable link from an input back to its
full spatial, temporal, and model context; without it, divergences between
inputs in resolution, day-boundary convention, or aggregation cannot be
detected at all.
explanation:
tag: explanation
value: 'Think of it as a tracking number: instead of copying all the details
of the ingredient into this record, we store a pointer to the record that
already holds them, and anyone can follow the pointer.'
description: The `provenance_id` of the upstream sidecar that fully describes
this input — its source dataset, spatial / temporal reference, and exposure
model. Dereferencing it lets a consumer (or the completeness checker) compare
inputs and surface any divergence in resolution, day-boundary convention, or
temporal aggregation.
title: Input Provenance ID
examples:
- value: 01HFA7K8R3M6XP-daymet-tmax
description: provenance_id of the upstream Daymet Tmax sidecar
from_schema: https://w3id.org/linkml/microschemas/envar
see_also:
- https://www.w3.org/TR/prov-o/
rank: 1000
owner: EquationInput
domain_of:
- EquationInput
range: string
required: true
input_source_short_code:
name: input_source_short_code
annotations:
tier:
tag: tier
value: recommended
justification:
tag: justification
value: Lets a human scanning the record see at a glance which product each
input came from without dereferencing every provenance id; because it is
a non-authoritative duplicate, omitting it costs readability, not machine-checkability.
explanation:
tag: explanation
value: A friendly nickname for the dataset an ingredient came from (like "daymet_v4"),
written next to the tracking number so people do not have to look everything
up just to get oriented.
covered_by:
tag: covered_by
annotations:
omop_gaia:
tag: omop_gaia
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: Single-input Tmax scenario; no heat-equation input decomposition,
so no per-input source short code.
degauss:
tag: degauss
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: No derived-metric equation inputs, so no per-input source code.
amadeus:
tag: amadeus
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: No derived-metric equation inputs, so no per-input source code.
cher:
tag: cher
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: C-HER models no heat-equation inputs.
codata:
tag: codata
annotations:
extent:
tag: extent
value: out_of_layer
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: Heat-equation input decomposition is instance-layer; out of
scope for CODATA.
description: Human-readable short code of the input's source product (e.g. `daymet_v4`,
`era5`), duplicated from the referenced sidecar for convenience when scanning
the record. Not authoritative — `input_provenance_id` is.
title: Input Source Short Code
examples:
- value: daymet_v4
from_schema: https://w3id.org/linkml/microschemas/envar
rank: 1000
owner: EquationInput
domain_of:
- EquationInput
range: string
See Also
Identifier and Mapping Information
Annotations
| property | value |
|---|---|
| domain_of_use | environmental_exposure |
Schema Source
- from schema: https://w3id.org/linkml/microschemas/envar
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | envar:EquationInput |
| native | envar:EquationInput |