Julia API index
Every stable name Julia exports, and its extension seams.
Package: EarthSciIO 0.1.4
Documentation extracted with Base.Docs (Julia 1.13.3).
Extension-tier names are on the Julia extension page .
Stable names
| Julia | Canonical | Kind | Summary |
|---|---|---|---|
Cache | cache | type | The content-addressed cache. |
cache_key | cache_key | function | lowercase_hex(sha256(utf8(resolved_url))). |
CacheEntry | cache_entry | type | The outcome of [fetch_blob]: the resolved blob plus how it was obtained. |
CacheMiss | cache_miss | error | Raised in offline mode when the blob for a resolved URL is absent. |
const_provider | const_provider | function | Thin constructor for a time-invariant ([CONST]) provider. |
CSVReader | csv_reader | type | The csv format reader — a second reader proving a non-NetCDF format plugs into FORMAT_REGISTRY unchanged (spec/conformance.md). |
datadir | data_dir | function | Resolve $EARTHSCIDATADIR (spec/cache-format.md §5). |
discrete_provider | discrete_provider | function | Thin constructor for a time-varying ([DISCRETE]) provider over times. |
FF10Reader | ff10_reader | type | The ff10 format reader — the RAW long-format FF10 point table (SMOKE / Emissions.jl FF10_POINT) as a points [NativeDataset] in native units. |
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 (spec/cache-format.md §4.1): is the file:// source behind a cached entry still the file that was ingested into it? |
GeoTIFFReader | geotiff_reader | type | The geotiff format reader — raster bands on a native lon/lat (geographic) or x/y (projected) grid. |
IntegrityError | integrity_error | error | Raised when a blob’s bytes do not match its manifest sha256_content. |
is_offline | is_offline | function | True if this cache is in offline (cache-only) mode. |
Manifest | manifest | type | Validation + provenance record for one cached blob. |
materialize | materialize | function | Return the native arrays for the source at time t. |
NativeDataset | native_dataset | type | The native arrays a reader returns from one blob: variables (data fields keyed by file_variable) and coords (the dimension-coordinate fields — e.g. the grid’s… |
NativeField | native_field | type | One native-grid array exactly as a reader decodes it: data is a Julia array whose axes correspond, in order, to dims (the on-disk dimension names, file order — e.g.… |
NetCDFReader | netcdf_reader | type | The netcdf format reader, backed by NCDatasets. |
ParquetReader | parquet_reader | type | The parquet format reader — an Apache Parquet file as a flat table. |
prefetch | prefetch | function | Warm the cache for every URL the provider will need — the single URL for a [CONST] provider, the unique per-tick URLs for a [DISCRETE] one — WITHOUT decoding. |
Provider | provider | type | A data provider over the shared cache. |
refresh | refresh | function | Re-materialize at the cadence tick t. |
refresh_times | refresh_times | function | The discrete time points at which the data changes and the solver must [refresh]. |
ShapefileReader | shapefile_reader | type | The shapefile format reader — an ESRI shapefile as a feature table. |
ZarrReader | zarr_reader | type | The zarr store-backed reader (Zarr v2 chunked arrays). |