Skip to content

euro-cordex/py-cordex

Repository files navigation

py-cordex: create cordex grids and meta data

Versions Python Package Index Build Conda-forge Build Version
Documentation Documentation Status Supported Python Versions py-cordex examples
Open Source License FAIR Software Compliance FOSSA DOI
Coding Standards Python Black pre-commit.ci status
Development Status Build Status Covecov
Funding Funding

This package offers python tools for the CORDEX community and should make your work with CORDEX grids and meta data easy. Most of the tools leverage the xarray API to create grid and coordinate informations and data of CORDEX domains in the form of an xarray.Dataset directly from the official CORDEX archive specifications.

Please have a look at the introduction noteboook!

Features

  • Tools to manage CORDEX grids as xarray datasets.
  • Includes coordinate transformations, bounds and vertices for CORDEX datasets.
  • Utitlities for cmorization to make the CORDEX ensembles more consistent.

You can use this package, e.g., to easily access CORDEX grid definitions:

import cordex as cx

cx.domain("EUR-11")

to create an xarray Dataset:

https://raw.githubusercontent.com/euro-cordex/py-cordex/main/docs/eur-11_xarray.png

and make a quick plot using the accessor:

cx.domain("EUR-11").cx.map()

https://raw.githubusercontent.com/euro-cordex/py-cordex/main/docs/eur-11.png

For planned features, please have a look at the issues, grab one, and contribute!

Installation

You can install py-cordex using pip or conda, e.g.

pip install py-cordex

or

conda install -c conda-forge py-cordex

Installation from source

For instructions to install py-cordex from source, please have a look at the contributing guide. If you want to contribute, please get in contact as early as possible, e.g., using draft pull requests.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Parts of this package have been developed within the project Pilot Lab Exascale Earth System Modelling (PL-ExaESM).