Metadata-Version: 2.1
Name: ValEnsPy
Version: 0.3.1
Summary: A Python package to validate gridded model data.
Home-page: https://github.com/CORDEX-be2/ValEnsPy
License: GPL-3.0
Keywords: validation,ensemble,climate,meteorology,model,data
Author: Kobe Vandelanotte
Author-email: kobe.vandelanotte@meteo.be
Maintainer: Kobe Vandelanotte
Maintainer-email: kobe.vandelanotte@meteo.be
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Dist: cartopy (>=0.23.0,<0.24.0)
Requires-Dist: cf-xarray (>=0.9.4,<0.10.0)
Requires-Dist: dask (>=2024.3.1,<2025.0.0)
Requires-Dist: docstring-parser (>=0.16,<0.17)
Requires-Dist: geopandas (>=1.0.1,<2.0.0)
Requires-Dist: matplotlib (>=3.8.3,<4.0.0)
Requires-Dist: nc-time-axis (>=1.4.1,<2.0.0)
Requires-Dist: netCDF4 (>=1.6.5,<2.0.0)
Requires-Dist: pandas (>=2.2.1,<3.0.0)
Requires-Dist: pooch (>=1.8.1,<2.0.0)
Requires-Dist: regionmask (>=0.12.1,<0.13.0)
Requires-Dist: scipy (>=1.13.0,<2.0.0)
Requires-Dist: seaborn (>=0.13.2,<0.14.0)
Requires-Dist: shapely (>=2.0.3,<3.0.0)
Requires-Dist: xarray (>=2023.12.0,<=2024.07.0)
Requires-Dist: xarray-datatree (==0.0.14)
Requires-Dist: xclim (>=0.54.0,<0.55.0)
Requires-Dist: xesmf (>=0.8.8,<0.9.0)
Project-URL: Documentation, https://cordex-be2.github.io/ValEnsPy/
Project-URL: Repository, https://github.com/CORDEX-be2/ValEnsPy
Description-Content-Type: text/markdown

# ValEnsPy
A Python package to validate ensembles gridded model data.

## Cloning the repository

To clone the repository, run the following command in your terminal:

```bash
git clone git@github.com:CORDEX-be2/ValEnsPy.git
```

## Installation

Install the development version of the package using conda:

Create a conda environment with the required non python packages
```bash
conda create -n valenspy_dev python=3.11 esmpy poetry=1.8 -c conda-forge
source activate valenspy_dev
```

Install the required packages using poetry. 
> [!IMPORTANT] 
> Ensure that you are in the ValEnsPy directory and on the dev branch (or your branch of choice).
```bash
poetry install --with examples
```

For more detailed installation instructions - [General install guide](docs/contribution_pages/INSTALL.md)

Interested in contributing? Take a look at our [contributing guidelines](docs/contribution_pages/CONTRIBUTING.md).

## Documentation
Take a look at our [documentation](https://cordex-be2.github.io/ValEnsPy/)

## Package structure

The package is structured as follows

![Package structure](docs/package_structure.png) 

