Version: v0.4.0

provider_from_esm

Stable function · Other

Tier: stable · Kind: function · Topic: Other

PythonJuliaRust
provider_from_esmprovider_from_esmnot exported

Python

provider_from_esm(name: str, entry: Mapping[str, Any], cache, *, variables: Sequence[str] = (), substitutions: Mapping[str, str] | None = None, url_override: str | None = None, records_per_sample: int | None = None, window=None, time_origin=None)

A Provider over an esm data_sources entry, bound to cache and the run window (UTC datetimes, or seconds from time_origin).

time_origin (a datetime or ISO 8601 string, a whole second) is the instant the provider counts time from, usually the model’s time origin (EarthSciAST’s time_origin(document)); with it, every time in and out is seconds from it (spec/esm-sources.md §4). An entry does not carry the model’s origin, so there is no default: without one, times are as before.

Source

Julia

provider_from_esm(name::AbstractString, entry, cache::Cache; variables, substitutions, url_override, records_per_sample, window, time_origin)
provider_from_esm(name, entry, cache; variables, substitutions=Dict(),
                  url_override=nothing, records_per_sample=nothing,
                  window=nothing, time_origin=nothing) -> Provider

A Provider over one esm data_sources entry (a parsed JSON object, as a document carries it after EarthSciAST loaded it), bound to cache and the run window (UTC: DateTimes, or seconds from time_origin). See spec/esm-sources.md §3. A time-varying source’s ticks are Unix seconds, or, with a time_origin (a DateTime or ISO 8601 string, a whole second, usually the model’s time origin from EarthSciAST’s time_origin(document)), seconds from it, in and out (§4). An entry does not carry the model’s origin, so there is no default.

Source

Rust

Rust does not export this function.