xcube-zenodo

xcube-zenodo is a Python package and xcube plugin that adds a data store named zenodo to xcube. The data store is used to access datasets which are published on Zenodo.

Installing the xcube-zenodo plugin

This section describes three alternative methods you can use to install the xcube-zenodo plugin.

For installation of conda packages, we recommend mamba. It is also possible to use conda, but note that installation may be significantly slower with conda than with mamba. If using conda rather than mamba, replace the mamba command with conda in the installation commands given below.

Installation into a new environment with mamba

This method creates a new environment and installs the latest conda-forge release of xcube-zenodo, along with all its required dependencies, into the newly created environment.

To do so, execute the following commands:

mamba create --name xcube-zenodo --channel conda-forge xcube-zenodo
mamba activate xcube-zenodo

The name of the environment may be freely chosen.

Installation into an existing environment with mamba

This method assumes that you have an existing environment, and you want to install xcube-zenodo into it.

With the existing environment activated, execute this command:

mamba install --channel conda-forge xcube-zenodo

Once again, xcube and any other necessary dependencies will be installed automatically if they are not already installed.

Installation into an existing environment from the repository

If you want to install xcube-zenodo directly from the git repository (for example in order to use an unreleased version or to modify the code), you can do so as follows:

mamba create --name xcube-zenodo --channel conda-forge --only-deps xcube-zenodo
mamba activate xcube-zenodo
git clone https://github.com/dcs4cop/xcube-cds.git
python -m pip install --no-deps --editable xcube-zenodo/

This installs all the dependencies of xcube-zenodo into a fresh conda environment, then installs xcube-cds into this environment from the repository.

Testing

To run the unit test suite:

pytest

To analyze test coverage:

pytest --cov=xcube_zenodo

To produce an HTML coverage report:

pytest --cov-report html --cov=xcube_zenodo