Metadata-Version: 2.2
Name: xcube_cci
Version: 0.11.5
Summary: An xcube plugin that allows generating data cubes from the ESA CCI Open Data Portal.
Author: ESA CCI Toolbox Development Team
License: MIT License
        
        Copyright (c) 2020 DCS4COP
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/esa-cci/xcube-cci
Project-URL: Bug Tracker, https://github.com/esa-cci/xcube-cci/issues
Project-URL: Changelog, https://github.com/esa-cci/xcube-cci/CHANGES.md
Project-URL: Download, https://pypi.org/project/xcube-cci/#files
Project-URL: Release notes, https://github.com/esa-cci/xcube-cci/releases
Keywords: data science,cci,climate data
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.6
Requires-Dist: lxml>=4.5
Requires-Dist: nest-asyncio>=1.3
Requires-Dist: numpy>=2
Requires-Dist: pydap>=3.4
Requires-Dist: rioxarray
Requires-Dist: xcube-core>=1.4.0
Requires-Dist: xvec
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"

[![Build Status](https://ci.appveyor.com/api/projects/status/7kum33o5g1osqg9l?svg=true)](https://ci.appveyor.com/project/bcdev/xcube-cci)

# xcube-cci

An [xcube plugin](https://xcube.readthedocs.io/en/latest/plugins.html) that allows 
generating data cubes from the ESA CCI Open Data Portal.

### Installing the xcube-cci plugin

#### Installation into a new environment with conda

xcube-cci and all necessary dependencies (including xcube itself) are available
on [conda-forge](https://conda-forge.org/), and can be installed using the
[conda package manager](https://docs.conda.io/projects/conda/en/latest/).
The conda package manager itself can be obtained in the [miniconda
distribution](https://docs.conda.io/en/latest/miniconda.html). 
Once conda is installed, xcube-cci can be installed like this:

```
$ conda create --name xcube-cci-environment --channel conda-forge xcube-cci
$ conda activate xcube-cci-environment
```

The name of the environment may be freely chosen.

#### Installation into an existing environment with conda

xcube-cci can also be installed into an existing conda environment.
With an existing conda environment activated, execute this command:

```
$ conda install --channel conda-forge xcube-cci
```

xcube and any other necessary dependencies will be installed or updated if they are not 
already installed in a compatible version.

#### Installation into an existing environment from the repository

If you want to install xcube-cci 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:

```
$ git clone https://github.com/esa-cci/xcube-cci.git
$ cd xcube-cci
$ conda env create
$ conda activate xcube-cci
$ pip install --no-deps -e .
```

## Testing

You can run the unit tests for xcube-cci by executing

```
$ pytest
```

in the `xcube-cci` repository. Note that, in order to successfully run the
tests using the current repository version of xcube-cci, you may also need to
install the repository version of xcube rather than its latest conda-forge
release.

To create a test coverage report, you can use

```
coverage run --include='xcube_cci/**' --module pytest
coverage html
```

This will write a coverage report to `htmlcov/index.html`.

## Use

Jupyter notebooks demonstrating the use of the xcube-cds plugin can be found
in the `examples/notebooks/` subdirectory of the repository.

## Releasing

To release `xcube-cci`, please follow the steps outlined in the 
[xcube Developer Guide](https://github.com/dcs4cop/xcube/blob/master/docs/source/devguide.md#release-process).
