About the xcube-resampling project

Changelog

You can find the complete xcube-resampling 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 xcube-resampling 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 xcube-resampling 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

xcube-resampling uses pytest for unit-level testing and code coverage analysis.

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

Code Style

The xcube-resampling source code is formatted and quality-controlled using ruff:

ruff format
ruff check

Documentation

The xcube-resampling 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

xcube-resampling is open source made available under the terms and conditions of the MIT license.