Skip to content

Latest commit

 

History

History
1893 lines (1461 loc) · 105 KB

changelog.rst

File metadata and controls

1893 lines (1461 loc) · 105 KB

Changelog

v2.12.0

Highlights

  • Preprocessor :func:`esmvalcore.preprocessor.extract_time` now allows to extract time blocks in each year by making parameters start_year and end_year optional.

  • A new way of :ref:`configuring the tool <config>` has been developed.

  • Performance improvements:

    • An iris-esmf-regrid scheme has been added to preprocessor :func:`esmvalcore.preprocessor.regrid`, which improves the regridding of 2D grids and adds the capability to regrid UGRID meshes out of the box.
    • Data is now saved from one preprocessing task at the time when using the distributed scheduler, in order to avoid running out of memory.
    • A better default num_workers has been set when using more than one max_parallel_tasks with an unconfigured threaded scheduler.
  • An on-the-fly cmorizer for ACCESS native data is now available.

This release includes

Backwards incompatible changes

Deprecations

  • Merge configuration object from multiple files (instead of one single file) (:pull:`2448`) by :user:`schlunma`

    • The single configuration file config-user.yml has been deprecated in favour of configuration directories. By default, the directory ~/.config/esmvaltool will be considered. To switch to the new format run:

      mkdir -p ~/.config/esmvaltool && mv ~/.esmvaltool/config-user.yml ~/.config/esmvaltool

      You can also specify the location of the configuration directory with the --config_dir flag. Please refer to :ref:`config` for a detailed description on how to configure the tool.

  • Make Dask configurable in our configuration (:pull:`2616`) by :user:`schlunma`

    • The old Dask configuration file that needed to be located at ~/.esmvaltool/dask.yml is now deprecated. Please refer to :ref:`config-dask` for a detailed description on how to configure Dask.

Bug fixes

CMOR standard

Configuration

Computational performance improvements

Documentation

Fixes for datasets

Installation

Iris

Preprocessor

Observational and re-analysis dataset support

Automatic testing

Variable Derivation

Improvements

v2.11.1

Highlights

This is a bugfix release which enables lazy computations in more preprocessors and allows installing the latests version of various dependencies, including Iris (v3.11.0).

This release includes

Computational performance improvements

Installation

Automatic testing

v2.11.0

Highlights

This release includes

Backwards incompatible changes

  • Allow contiguous representation of extracted regions (:pull:`2230`) by :user:`rebeccaherman1`
    • The preprocessor function :func:`esmvalcore.preprocessor.extract_region` no longer automatically maps the extracted :class:`iris.cube.Cube` to the 0-360 degrees longitude domain. If you need this behaviour, use cube.intersection(longitude=(0., 360.)) in your Python code after extracting the region. There is no possibility to restore the previous behaviour from a recipe.
  • Use iris.FUTURE.save_split_attrs = True to remove iris warning (:pull:`2398`) by :user:`schlunma`
    • Since v3.8.0, Iris explicitly distinguishes between local and global netCDF attributes. ESMValCore adopted this behavior with v2.11.0. With this change, attributes are written as local attributes by default, unless they already existed as global attributes or belong to a special list of global attributes (in which case attributes are written as global attributes). See :class:`iris.cube.CubeAttrsDict` for details.

Deprecations

  • Refactor regridding (:pull:`2231`) by :user:`schlunma`
    • This PR deprecated two regridding schemes, which will be removed with ESMValCore v2.13.0:
      • unstructured_nearest: Please use the scheme nearest instead. This is an exact replacement for data on unstructured grids. ESMValCore is now able to determine the most suitable regridding scheme based on the input data.
      • linear_extrapolate: Please use a generic scheme with reference: iris.analysis:Linear and extrapolation_mode: extrapolate instead.
  • Allow deprecated regridding scheme linear_extrapolate in recipe checks (:pull:`2324`) by :user:`schlunma`
  • Allow deprecated regridding scheme unstructured_nearest in recipe checks (:pull:`2336`) by :user:`schlunma`

Bug fixes

CMOR standard

Computational performance improvements

Documentation

Fixes for datasets

Installation

Preprocessor

Automatic testing

Improvements

v2.10.0

Highlights

This release includes

Backwards incompatible changes

Deprecations

  • Clearly separate fixes and CMOR checks (:pull:`2157`) by :user:`schlunma`
  • Added new operators for statistics preprocessor (e.g., 'percentile') and allowed passing additional arguments (:pull:`2191`) by :user:`schlunma`
    • This harmonizes the operators for all statistics preprocessors. From this version, the new names can be used; the old arguments will stop working from version 2.12.0. Please refer to :ref:`stat_preprocs` for a detailed description.

Bug fixes

CMOR standard

Computational performance improvements

Documentation

Fixes for datasets

Installation

Preprocessor

Automatic testing

Improvements

v2.9.0

Highlights

It is now possible to use the Dask distributed scheduler, which can significantly reduce the run-time of recipes. Configuration examples and advice are available in :ref:`our documentation <config-dask>`. More work on improving the computational performance is planned, so please share your experiences, good and bad, with this new feature in :discussion:`1763`.

This release includes

Backwards incompatible changes

Bug fixes

Computational performance improvements

Documentation

Fixes for datasets

Installation

Preprocessor

v2.8.1

Highlights

This release adds support for Python 3.11 and includes several bugfixes.

This release includes:

Bug fixes

Fixes for datasets

Installation

Documentation

Automatic testing

v2.8.0

Highlights

This release includes:

Backwards incompatible changes

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

Deprecations

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

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 :user:`malininae`
  • 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 :user:`schlunma`
  • Performance of preprocessor functions that use time dimensions has been sped up by two orders of magnitude thanks to contributions by :user:`bouweandela`

This release includes:

Backwards incompatible changes

Bug fixes

Deprecations

Documentation

Improvements

Fixes for datasets

Installation

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 :ref:`Supported native models: EMAC <read_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

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 (:pull:`1303`) by :user:`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 (:pull:`1530`) by :user:`schlunma`. 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

This release includes

Bug fixes

Deprecations

Documentation

Fixes for datasets

CMOR standard

Preprocessor

Automatic testing

Installation

Improvements

v2.3.1

This release includes

Bug fixes

Documentation

Fixes for datasets

Preprocessor

Installation

Improvements

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

Documentation

Fixes for datasets

CMOR standard

Preprocessor

Automatic testing

Notebook API (experimental)

Improvements

v2.1.0

This release includes

Bug fixes

Documentation

Improvements

Fixes for datasets

Preprocessor

v2.0.0

This release includes

Bug fixes

Documentation

Improvements

Fixes for datasets

Preprocessor

v2.0.0b9

This release includes

Bug fixes

Improvements

For older releases, see the release notes on https://github.com/ESMValGroup/ESMValCore/releases.