Skip to content

Commit

Permalink
Update changelog and dependencies for version 2.6 (#2740)
Browse files Browse the repository at this point in the history
* Update drf.py and add launch_levante.py, pending to clean

* Generate new release changelog

* Update version in environment

* Add missing line

* Remove unrelated file

* Add missing highlight

* Address review comments

* Add dot

* Change date
  • Loading branch information
sloosvel authored Jul 25, 2022
1 parent ccdaf80 commit 793c696
Show file tree
Hide file tree
Showing 4 changed files with 121 additions and 8 deletions.
101 changes: 101 additions & 0 deletions doc/sphinx/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,107 @@ Changelog
=========


.. _changelog-v2-6-0:

v2.6.0
------

Highlights
~~~~~~~~~~

- A new monitoring diagnostic has been added to allow the comparison of model runs against reference datasets. For details, see :ref:`Monitoring diagnostic to show multiple datasets in one plot (incl. biases) <api.esmvaltool.diag_scripts.monitor.multi_datasets>`.
- A tool has been developed to compare the output of recipe runs against previous runs, in order to detect in an automatized way breaking changes between releases. Find more information in :ref:`Comparing recipe runs <compare_recipe_runs>`.
- The recipe :ref:`Climate Change Hotspot <recipe_climate_change_hotspot.rst>` allows to compute hotspots in any rectangular region.

Please also note the highlights from the corresponding ESMValCore release :ref:`here<esmvalcore:changelog-v2-6-0>`.
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 <https://github.com/pypa/setuptools_scm/#default-versioning-scheme>`__, which extracts Python package versions from git metadata.

This release includes

Bug fixes
~~~~~~~~~

- Fix dtype for Marrmot recipe results (`#2646 <https://github.com/ESMValGroup/ESMValTool/pull/2646>`__) `SarahAlidoost <https://github.com/SarahAlidoost>`__
- Adapt test_fix_coords to new version of cf-units (`#2707 <https://github.com/ESMValGroup/ESMValTool/pull/2707>`__) `Klaus Zimmermann <https://github.com/zklaus>`__
- Fix nested axes in `recipe_martin18_grl` and `recipe_li17natcc` (`#2712 <https://github.com/ESMValGroup/ESMValTool/pull/2712>`__) `Lukas <https://github.com/lukruh>`__
- Update common_climdex_preprocessing_for_plots.R (`#2727 <https://github.com/ESMValGroup/ESMValTool/pull/2727>`__) `Enrico Arnone <https://github.com/earnone>`__

Community
~~~~~~~~~

- Collecting github user names for config-references (`#2677 <https://github.com/ESMValGroup/ESMValTool/pull/2677>`__) `Lukas <https://github.com/lukruh>`__

Deprecations
~~~~~~~~~~~~

- Deprecate the function `esmvaltool.diag_scripts.shared.var_name_constraint`. This function is scheduled for removal in v2.8.0. Please use :class:`iris.NameConstraint` with the keyword argument var_name instead: this is an exact replacement. (`#2655 <https://github.com/ESMValGroup/ESMValTool/pull/2655>`__) `Manuel Schlund <https://github.com/schlunma>`__

Documentation
~~~~~~~~~~~~~

- Documentation Improvements (`#2580 <https://github.com/ESMValGroup/ESMValTool/pull/2580>`__) `stacristo <https://github.com/stacristo>`__
- Fixed broken label in the documentation (`#2616 <https://github.com/ESMValGroup/ESMValTool/pull/2616>`__) `Rémi Kazeroni <https://github.com/remi-kazeroni>`__
- Add readthedocs configuration file (`#2627 <https://github.com/ESMValGroup/ESMValTool/pull/2627>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Update the command for building the documentation (`#2622 <https://github.com/ESMValGroup/ESMValTool/pull/2622>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Added DKRZ-Levante to `config-user-example.yml` (`#2632 <https://github.com/ESMValGroup/ESMValTool/pull/2632>`__) `Rémi Kazeroni <https://github.com/remi-kazeroni>`__
- Improved documentation on native dataset support (`#2635 <https://github.com/ESMValGroup/ESMValTool/pull/2635>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Add documentation on building and uploading Docker images (`#2662 <https://github.com/ESMValGroup/ESMValTool/pull/2662>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Remove support for Mistral in `config-user-example.yml` (`#2667 <https://github.com/ESMValGroup/ESMValTool/pull/2667>`__) `Rémi Kazeroni <https://github.com/remi-kazeroni>`__
- Add note to clarify that CORDEX support is work in progress (`#2682 <https://github.com/ESMValGroup/ESMValTool/pull/2682>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Restore accidentally deleted text from input data docs (`#2683 <https://github.com/ESMValGroup/ESMValTool/pull/2683>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Add running settings note in `recipe_wenzel16nat.yml` documentation (`#2692 <https://github.com/ESMValGroup/ESMValTool/pull/2692>`__) `sloosvel <https://github.com/sloosvel>`__
- Add a note on transferring permissions to the release manager (`#2688 <https://github.com/ESMValGroup/ESMValTool/pull/2688>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Update documentation on ESMValTool module at DKRZ (`#2696 <https://github.com/ESMValGroup/ESMValTool/pull/2696>`__) `Rémi Kazeroni <https://github.com/remi-kazeroni>`__
- Add note on how to run recipe_wenzel14jgr.yml (`#2717 <https://github.com/ESMValGroup/ESMValTool/pull/2717>`__) `sloosvel <https://github.com/sloosvel>`__
- Added conda forge feedstock repo link in README (`#2555 <https://github.com/ESMValGroup/ESMValTool/pull/2555>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__

Diagnostics
~~~~~~~~~~~

- Compute bias instead of correlation in `compare_salinity.py` (`#2642 <https://github.com/ESMValGroup/ESMValTool/pull/2642>`__) `sloosvel <https://github.com/sloosvel>`__
- Update monitor diagnostics (`#2608 <https://github.com/ESMValGroup/ESMValTool/pull/2608>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Add new Psyplot diagnostic (`#2653 <https://github.com/ESMValGroup/ESMValTool/pull/2653>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Reduce memory usage of lisflood recipe (`#2634 <https://github.com/ESMValGroup/ESMValTool/pull/2634>`__) `Stefan Verhoeven <https://github.com/sverhoeven>`__
- Provenance in ocean diagnostics (`#2651 <https://github.com/ESMValGroup/ESMValTool/pull/2651>`__) `Tomas Lovato <https://github.com/tomaslovato>`__
- Extend monitor diagnostics with multi-dataset plots (`#2657 <https://github.com/ESMValGroup/ESMValTool/pull/2657>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Recipe and diagnostics to plot climate change hotspots: Cos et al., ESD 2022 (`#2614 <https://github.com/ESMValGroup/ESMValTool/pull/2614>`__) `Pep Cos <https://github.com/pepcos>`__
- Update plots of consecutive dry days recipe (`#2671 <https://github.com/ESMValGroup/ESMValTool/pull/2671>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Fix the format of ids in Hype forcing files (`#2679 <https://github.com/ESMValGroup/ESMValTool/pull/2679>`__) `SarahAlidoost <https://github.com/SarahAlidoost>`__
- WFlow diagnostic script: remove manual rechunking (`#2680 <https://github.com/ESMValGroup/ESMValTool/pull/2680>`__) `Peter Kalverla <https://github.com/Peter9192>`__

Observational and re-analysis dataset support
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Extending the HadCRUT5 cmorizer (`#2509 <https://github.com/ESMValGroup/ESMValTool/pull/2509>`__) `Lisa Bock <https://github.com/LisaBock>`__
- Cmorize Kadow2020 dataset (`#2513 <https://github.com/ESMValGroup/ESMValTool/pull/2513>`__) `Lisa Bock <https://github.com/LisaBock>`__
- Cmorize NOAAGlobalTemp dataset (`#2515 <https://github.com/ESMValGroup/ESMValTool/pull/2515>`__) `Lisa Bock <https://github.com/LisaBock>`__
- Add option to CMORize ts as tos in ESACCI data (`#2731 <https://github.com/ESMValGroup/ESMValTool/pull/2731>`__) `sloosvel <https://github.com/sloosvel>`__

Automatic testing
~~~~~~~~~~~~~~~~~

- Add a tool for comparing recipe runs to previous runs (`#2613 <https://github.com/ESMValGroup/ESMValTool/pull/2613>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Ignore NCL interface files when comparing recipe runs (`#2673 <https://github.com/ESMValGroup/ESMValTool/pull/2673>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Add a short version of recipe deangelis15nat for testing (`#2685 <https://github.com/ESMValGroup/ESMValTool/pull/2685>`__) `katjaweigel <https://github.com/katjaweigel>`__
- Expanded recipe output comparison tool to better handle absolute paths in output (`#2709 <https://github.com/ESMValGroup/ESMValTool/pull/2709>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Update development infrastructure (`#2663 <https://github.com/ESMValGroup/ESMValTool/pull/2663>`__) `Bouwe Andela <https://github.com/bouweandela>`__

Installation
~~~~~~~~~~~~

- Removed `package/meta.yaml` and all references to it (`#2612 <https://github.com/ESMValGroup/ESMValTool/pull/2612>`__) `Manuel Schlund <https://github.com/schlunma>`__

Improvements
~~~~~~~~~~~~

- Improved handling of weights in MLR diagnostics (`#2625 <https://github.com/ESMValGroup/ESMValTool/pull/2625>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Fixed order of variables in perfemetrics plot of Anav13jclim recipe (`#2706 <https://github.com/ESMValGroup/ESMValTool/pull/2706>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Added input file sorting to many diagnostic to make output exactly reproducible (`#2710 <https://github.com/ESMValGroup/ESMValTool/pull/2710>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Removed 'ancestors' attributes before saving netcdf files in emergent constraints diagnostics (`#2713 <https://github.com/ESMValGroup/ESMValTool/pull/2713>`__) `Manuel Schlund <https://github.com/schlunma>`__

.. _changelog-v2-5-0:

v2.5.0
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dependencies:
- ecmwf-api-client
- eofs
- esmpy
- esmvalcore 2.5.*
- esmvalcore 2.6.*
- fiona
- fire
- gdal
Expand Down
2 changes: 1 addition & 1 deletion environment_osx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dependencies:
- ecmwf-api-client
- eofs
- esmpy
- esmvalcore 2.5.*
- esmvalcore 2.6.*
- fiona
- fire
- gdal
Expand Down
24 changes: 18 additions & 6 deletions esmvaltool/utils/draft_release_notes.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,36 @@
}

PREVIOUS_RELEASE = {
'esmvalcore': datetime.datetime(2021, 11, 8, 00),
'esmvaltool': datetime.datetime(2021, 11, 9, 00),
'esmvalcore': datetime.datetime(2022, 7, 15, 18),
'esmvaltool': datetime.datetime(2022, 7, 25, 18),
}


LABELS = {
'esmvalcore': (
'api',
'backwards incompatible change',
'bug',
'cmor',
'containerization',
'community',
'deployment',
'deprecated feature',
'documentation',
'enhancement',
'fix for dataset',
'cmor',
'installation',
'iris',
'preprocessor',
'api',
'release',
'testing',
'installation',
'enhancement',
'UX',
'variable derivation'
),
'esmvaltool': (
'backwards incompatible change',
'bug',
'community',
'deprecated feature',
'documentation',
'diagnostic',
Expand Down Expand Up @@ -122,6 +132,8 @@ def draft_notes_since(project, previous_release_date=None, labels=None):
continue
print(pull.updated_at, pull.merged_at, pull.number, pull.title)
pr_labels = {label.name for label in pull.labels}
if 'automatedPR' in pr_labels:
continue
for label in labels:
if label in pr_labels:
break
Expand Down

0 comments on commit 793c696

Please sign in to comment.