Metadata-Version: 2.4
Name: pyramids-lazy
Version: 0.1.1
Summary: Lazy / dask compute backend for pyramids (the pyramids.compute_backend plugin)
Author-email: Mostafa Farrag <moah.farag@gmail.com>
License: GNU General Public License v3
Project-URL: Homepage, https://github.com/serapeum-org/pyramids-lazy
Project-URL: Repository, https://github.com/serapeum-org/pyramids-lazy
Project-URL: Documentation, https://serapeum-org.github.io/pyramids-lazy/
Keywords: GIS,gdal,dask,zarr,lazy,pyramids
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Requires-Python: <4,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pyramids-core>=0.79.0
Requires-Dist: dask>=2024.1.0
Requires-Dist: distributed>=2024.1.0
Requires-Dist: zarr>=3
Requires-Dist: fsspec>=2024.1.0
Requires-Dist: s3fs>=2024.1.0
Requires-Dist: kerchunk>=0.2.10
Requires-Dist: h5py>=3.8.0
Provides-Extra: parquet
Requires-Dist: pyarrow>=10.0.0; extra == "parquet"
Requires-Dist: dask-geopandas>=0.5.0; extra == "parquet"
Dynamic: license-file

# pyramids-lazy

The lazy / dask compute backend for [pyramids](https://github.com/serapeum-org/pyramids-core).

`pyramids-lazy` implements the `ComputeBackend` contract published by `pyramids-core` and registers
it under the `pyramids.compute_backend` entry-point group. Installing it alongside `pyramids-core`
turns on every lazy/dask operation — lazy raster/variable reads, lazy cubes, `to_dask_dataframe`,
kerchunk manifests, multi-file dask reads, Zarr read/write for `Dataset` and `DatasetCollection`,
and lazy vector reads (GeoParquet / dask-geopandas) — **without** the dask/zarr stack ever being
pulled into a bare `pyramids-core` install.

```bash
pip install pyramids-lazy           # core + the full lazy stack
pip install pyramids-lazy[parquet]  # + the OGR-Parquet vector-lazy subset
```

No `import` or configuration is needed: once installed, `pyramids-core` discovers the backend
through the entry point and routes its lazy operations to it automatically.

## Design

- **No GDAL dependency.** The plugin inherits `pyramids-core`'s vendored GDAL; declaring GDAL here
  would risk a second, ABI-mismatched `libgdal` on the path.
- **One-directional coupling.** `pyramids-lazy` depends on `pyramids-core`, never the reverse, so
  core's release cadence stays independent of the dask/zarr stack.
- **Single backend object.** The entry point resolves to one `LazyComputeBackend` instance exposing
  one method per lazy operation plus an `api_version`.

## Documentation

<https://serapeum-org.github.io/pyramids-lazy/> — the backend contract, a reference page per lazy
operation, and installation notes. Built from `mkdocs.yml` + `docs/`.

## License

GNU General Public License v3.
