ESMValCore package

ESMValCore: core functionalities for the ESMValTool, a community diagnostic and performance metrics tool for routine evaluation of Earth System Models in CMIP.

Getting started

Installing from Anaconda

The Anaconda package can be found on ESMValGroup Anaconda Channel.

If you already have Anaconda installed, you can install ESMValCore by running:

conda install -c esmvalgroup -c conda-forge esmvalcore

Installing from source

If you need the very latest features, please see CONTRIBUTING.md for instructions on installing ESMValCore from source.

Using ESMValCore as a Python library

The ESMValCore package provides various functions for:

Finding data in a directory structure typically used for CMIP data
Reading CMOR tables and using those to check model and observational data.
ESMValTool preprocessor functions based on iris for e.g. regridding, vertical interpolation, statistics, correcting (meta)data errors, extracting a time range, etcetera.

Running ESMValTool

Review config-user.yml. To customize for your system, create a copy, edit and use the command line option -c to instruct esmvaltool to use your custom configuration file.
Install the ESMValTool to run ESMValTool recipes and diagnostics
Run e.g. esmvaltool -c ~/config-user.yml examples/recipe_python.yml after downloading the necessary data.

Getting help

The easiest way to get help if you cannot find the answer in the documentation on readthedocs, is to open an issue on GitHub.

Contributing

If you would like to contribute a new feature, please have a look at CONTRIBUTING.md.

Peter9192/ESMValCore