Changelog#

v2.8.0#

Highlights#

This release includes:

Backwards incompatible changes#

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

  • The algorithm for automatically defining the ancillary variables and cell measures has been improved (#1609) Bouwe Andela. If this does not work as expected, more examples of how to adapt your recipes are given here and in the corresponding sections of the recipe documentation and the preprocessor documentation.

  • Remove deprecated features scheduled for removal in v2.8.0 or earlier (#1826) Manuel Schlund. Removed esmvalcore.iris_helpers.var_name_constraint (has been deprecated in v2.6.0; please use iris.NameConstraint with the keyword argument var_name instead) and the option always_use_ne_mask for esmvalcore.preprocessor.mask_landsea() (has been deprecated in v2.5.0; the same behavior can now be achieved by specifying supplementary_variables.

  • No files will be found if a non-existent version of a dataset is specified (#1835) Bouwe Andela. If a version of a dataset is specified in the recipe, the tool will now search for exactly that version, instead of simply using the latest version. 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 default filename template for obs4MIPs has been updated to better match filenames used in this project in (#1866) Bouwe Andela. This may cause issues if you are storing all the files for obs4MIPs in a directory with no subdirectories per dataset.

Deprecations#

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

  • Various configuration related options that are now available through esmvalcore.config have been deprecated (#1769) Bouwe Andela.

  • The fx_variables preprocessor argument and related features have been deprecated (#1609) Bouwe Andela. See here for more information.

  • Combined offline and always_search_esgf into a single option search_esgf (#1935) Manuel Schlund. The configuration option/command line argument offline has been deprecated in favor of search_esgf. The previous offline: true is now search_esgf: never (the default); the previous offline: false is now search_esgf: when_missing. More details on how to adapt your workflow regarding these new options are given in #1935 and the documentation.

  • esmvalcore.preprocessor.cleanup() has been deprecated (#1949) Manuel Schlund. Please do not use this anymore in the recipe (it is not necessary).

Python API#

Bug fixes#

Documentation#

Improvements#

Fixes for datasets#

Installation#

Preprocessor#

Release#

Automatic testing#

Variable Derivation#

v2.7.1#

Highlights#

This is a bugfix release where we unpin cf-units to allow the latest iris=3.4.0 to be installed. It also includes an update to the default configuration used when searching the ESGF for files, to account for a recent change of the CEDA ESGF index node hostname. The changelog contains only changes that were made to the main branch.

Installation#

Bug fixes#

Automatic testing#

v2.7.0#

Highlights#

  • We have a new preprocessor function called ‘rolling_window_statistics’ implemented by Liza Malinina

  • We have improved the support for native models, refactored native model fixes by adding common base class NativeDatasetFix, changed default DRS for reading native ICON output, and added tests for input/output filenames for ICON and EMAC on-the-fly CMORizer, all these features courtesy of Manuel Schlund

  • Performance of preprocessor functions that use time dimensions has been sped up by two orders of magnitude thanks to contributions by Bouwe Andela

This release includes:

Backwards incompatible changes#

Bug fixes#

Deprecations#

  • Remove deprecation warning for regrid schemes already deprecated for v2.7.0 (#1753) Valeriu Predoi

Documentation#

Improvements#

Fixes for datasets#

  • Refactored native model fixes by adding common base class NativeDatasetFix (#1694) Manuel Schlund

Installation#

  • Pin netCDF4 != 1.6.1 since that seems to throw a flurry of Segmentation Faults (#1724) Valeriu Predoi

Automatic testing#

v2.6.0#

Highlights#

  • A new set of CMOR fixes is now available in order to load native EMAC model output and CMORize it on the fly. For details, see Supported native models: EMAC.

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

This release includes

Deprecations#

  • Deprecate the function esmvalcore.var_name_constraint (#1592) Manuel Schlund. 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.

Bug fixes#

CMOR standard#

Containerization#

Community#

Documentation#

Improvements#

Fixes for datasets#

Installation#

Preprocessor#

Release#

Automatic testing#

Variable Derivation#

v2.5.0#

Highlights#

This release includes

Backwards incompatible changes#

  • Update Cordex section in config-developer.yml (#1303) francesco-cmcc. This changes the naming convention of ESMValCore’s output files from CORDEX dataset. This only affects recipes that use CORDEX data. Most likely, no changes in diagnostics are necessary; however, if code relies on the specific naming convention of files, it might need to be adapted.

  • Dropped Python 3.7 (#1530) Manuel Schlund. ESMValCore v2.5.0 dropped support for Python 3.7. From now on Python >=3.8 is required to install ESMValCore. 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#

Fixes for datasets#

Preprocessor#

Automatic testing#

Installation#

Improvements#

v2.4.0#

Highlights#

  • ESMValCore now has the ability to automatically download missing data from ESGF. For details, see Data Retrieval.

  • ESMValCore now also can resume an earlier run. This is useful to re-use expensive preprocessor results. For details, see Running.

This release includes

Bug fixes#

Deprecations#

Documentation#

Fixes for datasets#

CMOR standard#

Preprocessor#

Automatic testing#

Installation#

  • Pin esmpy to anything but 8.1.0 since that particular one changes the CPU affinity (#1310) Valeriu Predoi

Improvements#

v2.3.1#

This release includes

Bug fixes#

Documentation#

Fixes for datasets#

Preprocessor#

  • Filter warnings about collapsing multi-model dimension in multimodel statistics preprocessor function (#1215) Bouwe Andela

  • Remove fx variables before computing multimodel statistics (#1220) sloosvel

Installation#

Improvements#

  • Add test to verify behaviour for scalar height coord for tas in multi-model (#1209) Peter Kalverla

  • Sort missing years in “No input data available for years” message (#1225) Lee de Mora

v2.3.0#

This release includes

Bug fixes#

Deprecations#

Documentation#

Fixes for datasets#

CMOR standard#

Preprocessor#

Notebook API (experimental)#

Automatic testing#

Installation#

Improvements#

v2.2.0#

Highlights#

ESMValCore 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 is also the first one including support for downloading CMIP6 data using Synda and we have also started supporting Python 3.9. Give it a try!

This release includes

Bug fixes#

Deprecations#

  • Deprecate defining write_plots and write_netcdf in config-user file (#808) Bouwe Andela

Documentation#

Fixes for datasets#

CMOR standard#

Preprocessor#

Automatic testing#

Notebook API (experimental)#

  • Implement importable config object in experimental API submodule (#868) Stef Smeets

  • Add loading and running recipes to the notebook API (#907) Stef Smeets

  • Add displaying and loading of recipe output to the notebook API (#957) Stef Smeets

  • Add functionality to run single diagnostic task to notebook API (#962) Stef Smeets

Improvements#

v2.1.0#

This release includes

Bug fixes#

Documentation#

Improvements#

Fixes for datasets#

Preprocessor#

  • Move cmor_check_data to early in preprocessing chain (#743) Bouwe Andela

  • Add RMS iris analysis operator to statistics preprocessor functions (#747) Pep Cos

  • Add surface chlorophyll concentration as a derived variable (#720) sloosvel

  • Use dask to reduce memory consumption of extract_levels for masked data (#776) Valeriu Predoi

v2.0.0#

This release includes

Bug fixes#

Documentation#

Improvements#

Fixes for datasets#

Preprocessor#

v2.0.0b9#

This release includes

Bug fixes#

  • Cast dtype float32 to output from zonal and meridional area preprocessors (#581) Valeriu Predoi

Improvements#

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