About the xarray-eopf project

Changelog

You can find the complete xarray-eopf changelog here.

Reporting

If you have suggestions, ideas, feature requests, or if you have identified a malfunction or error, then please post an issue.

Contributions

The xarray-eopf project welcomes contributions of any form as long as you respect our code of conduct and follow our contribution guide.

If you'd like to submit code or documentation changes, we ask you to provide a pull request (PR) here. For code and configuration changes, your PR must be linked to a corresponding issue.

Development

To install the xarray-eopf development environment into an existing Python environment, do

pip install .[dev,doc]

or create a new environment using conda or mamba

mamba env create 

Testing and Coverage

xarray-eopf uses pytest for unit-level testing and code coverage analysis.

pytest tests/ --cov=xarray_eopf --cov-report html

Code Style

The xarray-eopf source code is formatted and quality-controlled using ruff:

ruff format
ruff check

Documentation

The xarray-eopf documentation is built using the mkdocs tool.

With repository root as current working directory:

pip install .[doc]

mkdocs build
mkdocs serve
mkdocs gh-deploy

License

xarray-eopf is open source made available under the terms and conditions of the Apache 2.0 license.