Version: dev

This is the documentation for the development version. For the latest release, see v0.10.0.

deprecated_records_per_sample_sites

Stable function · Other

Tier: stable · Kind: function · Topic: Other

JuliaTypeScriptPythonRustGo
deprecated_records_per_sample_sitesdeprecatedRecordsPerSampleSitesdeprecated_records_per_sample_sitesdeprecated_records_per_sample_sitesDeprecatedRecordsPerSampleSites

Julia

deprecated_records_per_sample_sites(file::EsmFile)
deprecated_records_per_sample_sites(file::EsmFile) -> Vector{String}

The JSON pointers at which the deprecated records_per_sample (esm-spec §8.3, §8.5.1; removed at esm 3.0.0) is written in a loaded document, sorted (byte-order): /data_sources/<S>/temporal/records_per_sample and /models/<M>[/subsystems/<S>…]/variables/<v>/update[/<i>]/from/records_per_sample and /reaction_systems/<R>[/subsystems/<S>…]/parameters/<p>/update[/<i>]/from/records_per_sample (/<i> only for an array-form update). Empty when the document never writes it. The load entry points warn deprecated_records_per_sample once, naming these, when it is not empty.

Source

TypeScript

function deprecatedRecordsPerSampleSites(esmFile: EsmFile): string[]

The sorted JSON pointers at which the deprecated records_per_sample is written in esmFile (esm-spec §8.3, §8.5.1): /data_sources/<S>/temporal/records_per_sample and /models/<M>[/subsystems/<S>…]/variables/<v>/update[/<i>]/from/records_per_sample and /reaction_systems/<R>[/subsystems/<S>…]/parameters/<p>/update[/<i>]/from/records_per_sample. Components behind an unmounted {ref} are not visited.

Source

Python

deprecated_records_per_sample_sites(file: EsmFile) -> list[str]

The JSON pointers at which a loaded document writes the deprecated records_per_sample (esm-spec §8.3, §8.5.1; removed at esm 3.0.0), sorted by plain string order: /data_sources/<S>/temporal/records_per_sample and /models/<M>[/subsystems/<S>...]/variables/<v>/update[/<i>]/from/records_per_sample and /reaction_systems/<R>[/subsystems/<S>...]/parameters/<p>/update[/<i>]/from/records_per_sample (/<i> only for an array-form update). Mounted components are walked at the place they are mounted. The top-level loaders warn once, naming these, when the list is non-empty.

Source

Rust

pub fn deprecated_records_per_sample_sites(file: &EsmFile) -> Vec<String>

The JSON pointers at which the deprecated records_per_sample is written in file (esm-spec §8.5.1), sorted by plain byte order: /data_sources/<S>/temporal/records_per_sample, /models/<M>[/subsystems/<S>…]/variables/<v>/update[/<i>]/from/records_per_sample and /reaction_systems/<R>[/subsystems/<S>…]/parameters/<p>/update[/<i>]/from/records_per_sample (/<i> only for an array-form update). Loading a document for which this is non-empty warns once, deprecated_records_per_sample. Runs on every load, so a subsystem is scanned as raw JSON for the key, never decoded.

Source · Rust docs

Go

func DeprecatedRecordsPerSampleSites(file *ESMFile) []string

DeprecatedRecordsPerSampleSites lists, sorted, the JSON pointers at which a loaded document writes the deprecated records_per_sample (esm-spec §8.3, §8.5.1; removed at esm 3.0.0): /data_sources/<S>/temporal/records_per_sample, /models/<M>[/subsystems/<S>…]/variables/<v>/update[/<i>]/from/records_per_sample and /reaction_systems/<R>[/subsystems/<S>…]/parameters/<p>/update[/<i>]/from/records_per_sample (/<i> only for an array-form update). These are the places the load-time deprecated_records_per_sample warning names. It runs on every load, so a subsystem is scanned as raw JSON for the key, never decoded.

Source · Go docs