pixcdust.readers.zarr

Converted Pixcdust zarr database Reader.

Classes

ZarrReader

Zarr pixcdust database reader.

Module Contents

class pixcdust.readers.zarr.ZarrReader(path: str | Iterable[str] | pathlib.Path | Iterable[pathlib.Path], variables: list[str] | None = None, area_of_interest: geopandas.GeoDataFrame | None = None, conditions: dict[str, dict[str, str | float]] | None = None)[source]

Bases: pixcdust.readers.base_reader.BaseReader

Zarr pixcdust database reader.

Read a database from a Zarr database (folder). You can then request a xr.Dataset, pd.DataFrame or gpd.GeoDataFrame view of the database.

Attributes:

path: Path to read. variables: Optionally only read these variables. area_of_interest: Optionally only read points in area_of_interest. MULTI_FILE_SUPPORT: False, only support one file.

read(date_interval: Tuple[datetime.datetime, datetime.datetime] | None | None = None) → None[source]

Load a zarr database. You can then access from data or with methods like to_xarray, to_dataframe or to_geodataframe.

Args:
date_interval: Optional date filter on the database read.

Only load data dated within the interval.