Changelog#

v2.10.0#

Highlights

  • Add a realistic IPCC example recipe that reproduces figure 9.3 from AR6. It computes the mean sea-surface temperature anomaly between 1850-2100 over all available CMIP6 models. See the recipe documentation or read the blog post for more information.

  • Added more plot types to monitoring diagnostic: Hovmoeller Z vs. time, Hovmoeller time vs latlon, variable vs. latitude are now available. See the recipe documentation for more information.

  • Add support for 4 new datasets:

    • NOAA-CIRES-20CR v3 reanalysis

    • NASA MERRA reanalysis

    • NOAA marine boundary layer data for CH4

    • MOBO-DIC2004-2019

    See Supported datasets for which a CMORizer script is available and Observations for more information.

  • Many recipes now have up-to-date obs4MIPs dataset names so required data can automatically be downloaded from ESGF.

This release includes

Bug fixes#

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

Automatic testing#

Installation#

Improvements#

v2.9.0#

Highlights#

This release includes

Bug fixes#

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

Automatic testing#

Installation#

Improvements#

v2.8.0#

Highlights#

Highlights from ESMValCore v2.8.0 here:

  • ESMValCore now supports wildcards in recipes and offers improved support for ancillary variables and dataset versioning.

  • Support for CORDEX datasets in a rotated pole coordinate system has been added.

  • Native ICON output is now made UGRID-compliant on-the-fly.

  • The Python API has been extended with the addition of three modules: esmvalcore.config, esmvalcore.dataset, and esmvalcore.local

  • The preprocessor multi_model_statistics() has been extended to support more use-cases.

This release includes:

Backwards incompatible changes#

Please read the descriptions of the linked pull requests for detailed upgrade instructions.

  • Deprecated features scheduled for removal in v2.8.0 or earlier have now been removed (Pull request #2941) @schlunma. Removed esmvaltool.iris_helpers.var_name_constraint (has been deprecated in v2.6.0; please use iris.NameConstraint with the keyword argument var_name instead). Removed write_netcdf and write_plots from recipe_filer.py.

  • No files from the native6 project will be found if a non-existent version of a dataset is specified (#3041) @remi-kazeroni. The tool now searches for exact version of native6 datasets. Therefore, it is necessary to make sure that the version number in the directory tree matches with the version number in the recipe to find the files.

  • The conversion of precipitation units from monitoring diagnostic is now done at the preprocessor stage (#3049) @schlunma. To use the unit conversion for precipitation in the new version of this diagnostic, add it as a preprocessor for the precipitation dataset to the recipe.

Bug fixes#

Community#

Deprecations#

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

Automatic testing#

Installation#

Improvements#

v2.7.0#

Highlights#

  • This release has seen the inclusion of the code for figures 3.3, 3.4, 3.5, 3,13 and 3.15 of the IPCC AR6 WG1 report, see them in the new documentation

  • We have also included new diagnostics and recipe necessary to produce the plots and tables for the journal article “Climate model projections from the Scenario Model Intercomparison Project (ScenarioMIP) of CMIP6” by Tebaldi et al. in ESD 2020-68 from 2021; also see the recipe entry

  • We have also extended the support for MERRA2 observational dataset, by adding support for a large number of variables, including 3D variables, see the table of supported obs datasets

Backwards incompatible changes#

Bug fixes#

Community#

Deprecations#

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

Automatic testing#

Installation#

Improvements#

v2.6.0#

Highlights#

Please also note the highlights from the corresponding ESMValCore release here. Thanks to that ESMValTool has gained the following features:

  • A new set of CMOR fixes is now available in order to load native EMAC model output and CMORize it on the fly.

  • The version number of ESMValCore is now automatically generated using setuptools_scm, which extracts Python package versions from git metadata.

This release includes

Bug fixes#

Community#

Deprecations#

  • Deprecate the function esmvaltool.diag_scripts.shared.var_name_constraint. This function is scheduled for removal in v2.8.0. Please use iris.NameConstraint with the keyword argument var_name instead: this is an exact replacement. (Pull request #2655) @schlunma

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

Automatic testing#

Installation#

Improvements#

v2.5.0#

Highlights#

Please also note the highlights from the corresponding ESMValCore release here. Thanks to that ESMValTool has gained the following features:

  • The new preprocessor extract_location can extract arbitrary locations on the Earth.

  • Time ranges can now be extracted using the ISO 8601 format.

  • The new preprocessor ensemble_statistics can calculate arbitrary statistics over all ensemble members of a simulation.

This release includes

Backwards incompatible changes#

  • Streamline observations download (Pull request #1657) Javier Vegas-Regidor. This change removes the cmorize_obs command which has previously been used to CMORize observations and other datasets. The new command esmvaltool data provides many new features apart from the CMORization (esmvaltool data format), for example, automatic downloading of observational datasets (esmvaltool data download). More details on this can be found here and here.

  • Dropped Python 3.7 (Pull request #2585) @schlunma. ESMValTool v2.5.0 dropped support for Python 3.7. From now on Python >=3.8 is required to install ESMValTool. The main reason for this is that conda-forge dropped support for Python 3.7 for OSX and arm64 (more details are given here).

Bug fixes#

Deprecations#

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

  • Ensure dummy data for cmorize_obs_woa test are written to the correct directory (Pull request #2451) @ehogan

  • Add ESA CCI LST cmorizer and diagnostic (see previous section Diagnostics)

Automatic testing#

Installation#

Improvements#

v2.4.0#

Highlights#

  • ESMValTool is moving from Conda to Mamba as the preferred installation method. This will speed up the installation and comes with some improvements behind the scenes. Read more about it at Move to Mamba and in the installation guide.

Please also note the highlights from the corresponding ESMValCore release here. Thanks to that ESMValTool has gained the following features:

  • Download any missing data that is available on the ESGF automatically.

  • Resume previous runs, reusing expensive pre-processing results.

This release includes

Bug fixes#

Deprecations#

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

Automatic testing#

Installation#

Improvements#

v2.3.0#

This release includes

Bug fixes#

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

Automatic testing#

Installation#

Improvements#

v2.2.0#

Highlights#

ESMValTool is now using the recently released Iris 3. We acknowledge that this change may impact your work, as Iris 3 introduces several changes that are not backward-compatible, but we think that moving forward is the best decision for the tool in the long term.

This release includes

Bug fixes#

Deprecations#

Documentation#

Diagnostics#

Observational and re-analysis dataset support#

Automatic testing#

Installation#

Improvements#

v2.1.1#

This release includes

Improvements#

Documentation#

v2.1.0#

This release includes

Diagnostics#

Documentation#

Improvements#

Observational and re-analysis dataset support#

v2.0.0#

This release includes

Bug fixes#

Diagnostics#

Documentation#

Improvements#

Observational and re-analysis dataset support#

v2.0.0b4#

This release includes

Bug fixes#

Diagnostics#

Documentation#

Improvements#

Observational and re-analysis dataset support#

For older releases, see the release notes on ESMValGroup/ESMValTool.