Metadata-Version: 2.2
Name: xarray-eopf
Version: 0.1.0.dev0
Summary: A backend implmentation for xarray that allows for analysis-ready reading of ESA EOPF data products.
Author: Konstantin Ntokas (Brockmann Consult GmbH), Norman Fomferra (Brockmann Consult GmbH)
License: Apache-2.0
Project-URL: Documentation, https://eopf-sample-service.github.io/xarray-eopf
Project-URL: Repository, https://github.com/EOPF-Sample-Service/xarray-eopf
Project-URL: Changelog, https://github.com/EOPF-Sample-Service/xarray-eopf/blob/main/CHANGES.md
Project-URL: Issues, https://github.com/EOPF-Sample-Service/xarray-eopf/issues
Keywords: copernicus,esa,eopf,sentinel,xarray,zarr
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fsspec
Requires-Dist: numpy
Requires-Dist: xarray>=2024.10
Requires-Dist: zarr
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: hatch; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: jupyterlab; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Provides-Extra: doc
Requires-Dist: mkdocs; extra == "doc"
Requires-Dist: mkdocs-autorefs; extra == "doc"
Requires-Dist: mkdocs-material; extra == "doc"
Requires-Dist: mkdocstrings; extra == "doc"
Requires-Dist: mkdocstrings-python; extra == "doc"

# xarray-eopf

A backend implementation for [xarray](https://docs.xarray.dev/en/stable/user-guide/io.html) 
that allows for analysis-ready reading of ESA EOPF data products from local and remote 
filesystems.


## Development

### Setting up a development environment

The recommended Python distribution for development is 
[miniforge](https://conda-forge.org/download/) which includes 
conda, mamba, and their dependencies.

```shell
git clone https://github.com/EOPF-Sample-Service/xarray-eopf.git
cd xarray-eopf
mamba env create
mamba activate eopf-xr
pip install -ve .
```

### Install the library locally and test

```shell
mamba activate eopf-xr
pip install -ve .
pytest
```

### Documentation

### Setting up a documentation environment

```shell
mamba activate eopf-xr
pip install .[doc]
```

### Testing documentation changes

```shell
mkdocs serve
```

### Deploying documentation changes

```shell
mkdocs gh-deploy
```
