Python API index

Every stable name Python exports, and its extension seams.

Package: earthsciio 0.3.0

Documentation extracted with griffe 2.3.2.

Extension-tier names are on the Python extension page .

Stable names

Python	Canonical	Kind	Summary
`Cache`	`cache`	type	A content-addressed fetch cache over a pluggable `Store`.
`cache_key`	`cache_key`	function	Return the lowercase-hex sha256 of the resolved URL.
`CacheEntry`	`cache_entry`	type	The result of a fetch: where the blob is + how it got there.
`CacheMiss`	`cache_miss`	error	Raised in offline mode when the blob for a resolved URL is absent.
`CalendarPeriod`	`calendar_period`	type	A cadence step of `months` calendar months plus `seconds` seconds.
`CalendarPeriodError`	`calendar_period_error`	error	An ISO 8601 period EarthSciIO cannot read; the message contains `esm_period_invalid`.
`CommitError`	`commit_error`	type	An owner’s `commit` refused the delivered tokens (`spec/writer.md` §5.3): a missing or duplicate writer, a divergent fingerprint, a gap or an overlap between regions, divergent…
`CSVReader`	`csv_reader`	type	The active `csv` reader — a non-NetCDF format behind the same registry.
`DataSource`	`data_source`	type	The I/O-relevant projection of an ESS `DataSource` the Provider needs.
`decode_time_axis`	`decode_time_axis`	function	The Unix seconds (UTC, floored to the second) of a raw CF time axis, or `None` when it cannot be decoded (`spec/esm-sources.md` §2.5).
`DimWindow`	`dim_window`	type	A window that names its dimensions (`spec/prefetch.md` §2.2).
`EarthSciIOError`	`error`	error	Base class for every EarthSciIO error.
`EpochSample`	`epoch_sample`	type	Every member’s `Sample` for one epoch: `ep["U"].data`.
`esm_template_names`	`esm_template_names`	function	The substitution names `template` needs, in order of first appearance, without `date`.
`EsmSourceError`	`esm_source_error`	error	An esm data source EarthSciIO cannot read.
`EsmTemplate`	`esm_template`	type	A loader URL that is an esm template (spec/esm-sources.md §1.5).
`EsmTemplateError`	`esm_template_error`	error	An esm URL template could not be expanded.
`expand_esm_template`	`expand_esm_template`	function	Expand an esm URL template at `anchor` (a UTC instant; a naive datetime is read as UTC) with `substitutions`.
`FF10Reader`	`ff10_reader`	type	The active `ff10` reader — the RAW long-format FF10 point table.
`file_source_is_current`	`file_source_is_current`	function	Rung 0 as a yes/no: is the source provably the file that was ingested?
`file_source_state`	`file_source_state`	function	Rung 0 without a memo: what is the `file://` source behind this entry?
`GeoTIFFReader`	`geotiff_reader`	type	The active `geotiff` reader — raster bands on a native lon/lat grid.
`IntegrityError`	`integrity_error`	error	A cached or freshly downloaded blob failed its checksum / size check.
`JSONReader`	`json_reader`	type	The active `json` reader: a JSON array of records becomes a points table.
`Manifest`	`manifest`	type	In-memory view of `meta/<key>.json` (see the schema for field meanings).
`NativeDataset`	`native_dataset`	type	The native arrays from one blob: data `variables` + grid `coords`.
`NativeField`	`native_field`	type	One native-grid array as a reader decodes it.
`NetCDFReader`	`netcdf_reader`	type	The active `netcdf` reader, backed by xarray (netCDF4 engine).
`ParquetReader`	`parquet_reader`	type	The active `parquet` reader — an Apache Parquet file as a flat table.
`PrefetchGroup`	`prefetch_group`	type	Background decode of upcoming forcing epochs (`spec/prefetch.md` §3).
`Provider`	`provider`	type	A loader-bound provider of native-grid arrays, refreshed at the loader’s cadence.
`provider_from_esm`	`provider_from_esm`	function	A `Provider` over an esm `data_sources` entry, bound to `cache` and the run `window` (UTC datetimes).
`RegionNotShardAligned`	`region_not_shard_aligned`	type	A writer region violates the alignment rule of `spec/writer.md` §4.
`resolve_cache_root`	`data_dir`	function	Resolve the cache root directory.
`resolve_offline`	`is_offline`	function	Resolve effective offline mode.
`Sample`	`prefetch_sample`	type	One member’s data for one epoch.
`sha256_file`	`sha256_file`	function	sha256 of a file’s contents, streamed so large blobs don’t load to RAM.
`ShapefileReader`	`shapefile_reader`	type	The active `shapefile` reader — an ESRI shapefile as a feature table.
`source_from_esm`	`source_from_esm`	function	The `DataSource` an esm `data_sources` entry declares (spec/esm-sources.md §3).
`SourceTemporal`	`source_temporal`	type	The temporal cadence of a DISCRETE loader (absent ⇒ CONST).
`Temporal`	`temporal`	type	The freshness policy derived from a loader’s `temporal` block.
`Window`	`window`	type	A run window `(start, end)` — half-open `[start, end)`.