Metadata-Version: 2.1
Name: esa_climate_toolbox
Version: 1.1
Summary: The ESA CCI Toolbox is designed to provide access to CCI data
Author: ESA CCI Toolbox Development Team
License: MIT License
        
        Copyright (c) 2023 ESA Climate Change Initiative
        
        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/esa-climate-toolbox
Project-URL: Bug Tracker, https://github.com/esa-cci/esa-climate-toolbox/issues
Project-URL: Changelog, https://github.com/esa-cci/esa-climate-toolbox/CHANGES.md
Project-URL: Documentation, https://esa-climate-toolbox.readthedocs.io
Project-URL: Download, https://pypi.org/project/esa-climate-toolbox/#files
Project-URL: Release notes, https://github.com/esa-cci/esa-climate-toolbox/releases
Keywords: data science,cci,climate data
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.6
Requires-Dist: cartopy
Requires-Dist: cftime
Requires-Dist: dask
Requires-Dist: geopandas
Requires-Dist: lxml>=4.5
Requires-Dist: matplotlib
Requires-Dist: nest-asyncio>=1.3
Requires-Dist: numcodecs
Requires-Dist: numpy>=2
Requires-Dist: pandas
Requires-Dist: pydap>=3.4
Requires-Dist: pyproj
Requires-Dist: python-dateutil
Requires-Dist: rioxarray
Requires-Dist: shapely
Requires-Dist: six
Requires-Dist: xarray
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/ofws8cu11xpw89tu?svg=true)](https://ci.appveyor.com/project/bcdev/esa-climate-toolbox)
[![Documentation Status](https://readthedocs.org/projects/esa-climate-toolbox/badge/?version=latest)](https://esa-climate-toolbox.readthedocs.io/en/latest/?badge=latest)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/esa-climate-toolbox/badges/version.svg)](https://anaconda.org/conda-forge/esa-climate-toolbox)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/esa-climate-toolbox/badges/license.svg
)](https://anaconda.org/conda-forge/esa-climate-toolbox)

# ESA CCI Toolbox

The ESA CCI Toolbox is designed to provide access to CCI data from the ESA 
Open Data Portal. 
Also, it contains functions to operate on this data.

## Installation into a new environment with conda

The ESA CCI Toolbox and all necessary dependencies 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, the ESA CCI Toolbox can be installed like this:

```
$ conda create --name ect --channel conda-forge esa-climate-toolbox
$ conda activate ect
```

The name of the environment may be freely chosen.

#### Installation into an existing environment with conda

The ESA CCI Toolbox can also be installed into an existing conda 
environment.
To do so, execute this command with the existing environment activated:

```
$ conda install --channel conda-forge esa-climate-toolbox
```

Any 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 the ESA CCI Toolbox 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/esa-climate-toolbox.git
$ cd esa-climate-toolbox
$ conda env create
$ conda activate ect
$ pip install -e .
```

## Testing

You can run the unit tests for the ESA CCI Toolbox by executing

```
$ pytest
```

in the `esa-climate-toolbox` repository. 

To create a test coverage report, you can use

```
coverage run --include='esa-climate-toolbox/**' --module pytest
coverage html
```

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

## Use

Jupyter notebooks demonstrating the use of the ESA CCI Toolbox can be found
in the `notebooks/` subdirectory of the repository.

## Releasing

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