Version: dev

Python API index

Every stable name Python exports, and its extension seams.

Package: earthsciio 0.1.4

Documentation extracted with griffe 2.3.2.

Extension-tier names are on the Python extension page .

Stable names

PythonCanonicalKindSummary
CachecachetypeA content-addressed fetch cache over a pluggable Store.
cache_keycache_keyfunctionReturn the lowercase-hex sha256 of the resolved URL.
CacheEntrycache_entrytypeThe result of a fetch: where the blob is + how it got there.
CacheMisscache_misserrorRaised in offline mode when the blob for a resolved URL is absent.
CSVReadercsv_readertypeThe active csv reader — a non-NetCDF format behind the same registry.
DataSourcedata_sourcetypeThe I/O-relevant projection of an ESS DataSource the Provider needs.
EarthSciIOErrorerrorerrorBase class for every EarthSciIO error.
FF10Readerff10_readertypeThe active ff10 reader — the RAW long-format FF10 point table.
file_source_is_currentfile_source_is_currentfunctionRung 0 as a yes/no: is the source provably the file that was ingested?
file_source_statefile_source_statefunctionRung 0 without a memo: what is the file:// source behind this entry?
GeoTIFFReadergeotiff_readertypeThe active geotiff reader — raster bands on a native lon/lat grid.
IntegrityErrorintegrity_errorerrorA cached or freshly downloaded blob failed its checksum / size check.
ManifestmanifesttypeIn-memory view of meta/<key>.json (see the schema for field meanings).
NativeDatasetnative_datasettypeThe native arrays from one blob: data variables + grid coords.
NativeFieldnative_fieldtypeOne native-grid array as a reader decodes it.
NetCDFReadernetcdf_readertypeThe active netcdf reader, backed by xarray (netCDF4 engine).
ParquetReaderparquet_readertypeThe active parquet reader — an Apache Parquet file as a flat table.
ProviderprovidertypeA loader-bound provider of native-grid arrays, refreshed at the loader’s cadence.
resolve_cache_rootdata_dirfunctionResolve the cache root directory.
resolve_offlineis_offlinefunctionResolve effective offline mode.
sha256_filesha256_filefunctionsha256 of a file’s contents, streamed so large blobs don’t load to RAM.
ShapefileReadershapefile_readertypeThe active shapefile reader — an ESRI shapefile as a feature table.
SourceTemporalsource_temporaltypeThe temporal cadence of a DISCRETE loader (absent ⇒ CONST).
TemporaltemporaltypeThe freshness policy derived from a loader’s temporal block.
WindowwindowtypeA run window (start, end) — half-open [start, end).