From 4dadca5716a9a0ae26e14f7cf79a5bcc59d1757a Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Thu, 29 Aug 2024 17:04:09 +0100 Subject: [PATCH 1/7] Whatsnew updates for v0.20.0 . --- docs/ref/release_notes.rst | 119 +++++++++++++++++++++++++++++++++++-- 1 file changed, 115 insertions(+), 4 deletions(-) diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index b27c08b4..1a4a248c 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -10,10 +10,14 @@ What's new in iris-grib v0.20.0 ------------------------------- :Release: 0.20.0 -:Date: [unreleased] +:Date: 29 August 2024 Features ^^^^^^^^ +* `@abooton `_ added support for saving data on a + Lambert Azimuthal Equal Area (LAEA) projection, as grid definition template 3.140. + `(PR#343 `_ + * `@trexfeathers `_, `@mo-marqh `_ and `@pp-mo `_ added support for production definition template @@ -30,6 +34,10 @@ Features grid definition template 20 - polar stereographic. `(PR#405) `_ +* `@pp-mo `_ made essential changes for compatibility with + Iris >= 3.10. + `(PR#463) `_ + Documentation ^^^^^^^^^^^^^ @@ -39,11 +47,16 @@ Documentation doctests. `(ISSUE#398) `_ +* `@bjlittle `_ added the logo to README.md . + `(PR#447) `_ + +* `@tkknight `_ fixed the display formatting of linux + commands. + `(PR#455) `_ + + Dependencies ^^^^^^^^^^^^ -* `@bjlittle `_ migrated to ``pytest``. - `(PR#420) `_ - * `@pp-mo `_ enabled support for `eccodes v2.36 `_. Eccodes v2.36 has implemented some backwards incompatible changes : @@ -53,6 +66,104 @@ Dependencies The resulting changes mean **we now only support eccodes >=2.33**. `(PR#504) `_ +* `@bjlittle `_ added iris-sample-data as a dependency, + as required for doctests. + `(PR#413) `_ + +* `@pp-mo `_ made compatible with Iris >= 3.10 . + `(PR#463) `_ + + +Internal +^^^^^^^^ +* `@ESadek-MO `_ updated CONTRIBUTING.md in line with the + newer v5 SciTools CLA. `(PR#371) `_ + +* `@trexfeathers `_ added a pre-commit configuration. + `(PR#400) `_ + +* `@HGWright `_ replaced setup.py with pyproject.toml. + `(PR#408) `_ + +* `@ESadek-MO `_ configured for MyPy checking via + pre-commit. `(PR#407) `_ + +* `@ESadek-MO `_ migrated CI testing from Cirrus to + GitHub Actions. + `(PR#415) `_ + +* `@trexfeathers `_ and + `@HGWright `_ adopted Ruff for code style checking. + `(PR#430) `_, + `(PR#419) `_ + +* `@bjlittle `_ migrated the test runs from + nose to pytest. + `(PR#420) `_ + +* `@stephenworsley `_ removed the now-redundant + _iris_mercator_support.py. + `(PR#433) `_ + +* `@bjlittle `_ added build manifest checking in GHA. + `(PR#427) `_ + +* `@bjlittle `_ added dependabot checking. + `(PR#426) `_ + +* `@pp-mo `_ removed obsolete workaround routines relating to + older eccodes versions. + `(PR#410) `_ + +* `@HGWright `_ implemented version handling with + setuptools.scm . + `(PR#444) `_ + +* `@bjlittle `_ moved the top-level ``./iris_grib`` folder + to ``./src/iris_grib``, in line with modern practice, as per + `repo-review `_. + `(PR#450) `_ + +* `@bjlittle `_ dropped Python 3.9 support and added 3.12, + in accordance with `nep29 `_. + `(PR#453) `_ + +* `@bjlittle `_ updated all optional dependency + requirements, and added codecov support. + `(PR#454) `_, + `(PR#459) `_ + +* `@bjlittle `_ added repository health checking with + `repo-review `_ + via pre-commit. + `(PR#456) `_ + +* `@bjlittle `_ added a CODE_OF_CONDUCT.md . + `(PR#460) `_ + +* `@tkknight `_ made docs builds treat warnings as errors. + `(PR#471) `_ + +* `@githubalexliu `_ fixed a problem with the MyPy + checking. + `(PR#497) `_ + +* `@trexfeathers `_ aligned the pre-commit-config with + the SciTools "reference" version. + `(PR#464) `_, + + +New Contributors +^^^^^^^^^^^^^^^^ +Welcome to +* `@abooton `_ +* `@githubalexliu `_ +* `@stephenworsley `_ +* `@tkknight `_ fixed the display formatting of linux +* `@DPeterK `_ +* `@ESadek-MO `_ +* `@HGWright `_ + What's new in iris-grib v0.19.1 ------------------------------- From 06d2908336db09dcafc895b6221646bff0ab5d78 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Thu, 29 Aug 2024 18:07:34 +0100 Subject: [PATCH 2/7] Further improvements --- docs/ref/release_notes.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index 1a4a248c..be3d73f5 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -16,7 +16,7 @@ Features ^^^^^^^^ * `@abooton `_ added support for saving data on a Lambert Azimuthal Equal Area (LAEA) projection, as grid definition template 3.140. - `(PR#343 `_ + `(PR#343) `_ * `@trexfeathers `_, `@mo-marqh `_ and @@ -25,7 +25,7 @@ Features `(PR#401) `_ * `@pp-mo `_ expanded the use of the "GRIB_PARAM" - attributes to GRIB1 loading, and document it more thoroughly. + attributes to GRIB1 loading, and documented it more thoroughly. `(ISSUE#330) `_, `(PR#402) `_ @@ -45,7 +45,8 @@ Documentation headline basic load + save with Iris, rather than lower-level functions; better explain load-pairs and save-pairs usage; make all usage examples into doctests. - `(ISSUE#398) `_ + `(ISSUE#398) `_, + `(PR#402) `_ * `@bjlittle `_ added the logo to README.md . `(PR#447) `_ @@ -61,7 +62,7 @@ Dependencies `eccodes v2.36 `_. Eccodes v2.36 has implemented some backwards incompatible changes : The ``indicatorOfUnitOfTimeRange`` key was removed, to be replaced with - ``indicatorOfUnitForForecastTime`` (but only in GRIB v2 messages only, not GRIB 1); + ``indicatorOfUnitForForecastTime`` (but only in GRIB v2 messages, not GRIB 1); and the ``iScansPositively`` and ``jScansPositively`` keys became read-only. The resulting changes mean **we now only support eccodes >=2.33**. `(PR#504) `_ @@ -156,6 +157,7 @@ Internal New Contributors ^^^^^^^^^^^^^^^^ Welcome to + * `@abooton `_ * `@githubalexliu `_ * `@stephenworsley `_ @@ -241,6 +243,7 @@ Dependencies New Contributors ^^^^^^^^^^^^^^^^ Welcome to + * `@s-boardman `_ * `@david-bentley `_ * `@valeriupredoi `_ From b4dce4aa8ead5c1cc4eb86aaf7cc55a2c45fa185 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Thu, 29 Aug 2024 18:09:12 +0100 Subject: [PATCH 3/7] Adjust version on main page. --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index f8fceba9..2ee20638 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Iris-grib v0.20 (unreleased) -============================ +Iris-grib v0.20 +=============== The library ``iris-grib`` provides functionality for converting between weather and climate datasets that are stored as GRIB files and Iris :class:`~iris.cube.Cube`\s. From df21345a1160016275250d8bfcd5e5113d806451 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Thu, 29 Aug 2024 18:12:53 +0100 Subject: [PATCH 4/7] Fix issue/pr ref --- docs/ref/release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index be3d73f5..6bf6c876 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -46,7 +46,7 @@ Documentation better explain load-pairs and save-pairs usage; make all usage examples into doctests. `(ISSUE#398) `_, - `(PR#402) `_ + `(PR#402) `_ * `@bjlittle `_ added the logo to README.md . `(PR#447) `_ From 3f4cf8e35a573f702a9259c66175bd543c95dd3b Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Fri, 30 Aug 2024 11:31:55 +0100 Subject: [PATCH 5/7] Update docs/ref/release_notes.rst Co-authored-by: Martin Yeo <40734014+trexfeathers@users.noreply.github.com> --- docs/ref/release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index 6bf6c876..abbaa80b 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -77,7 +77,7 @@ Dependencies Internal ^^^^^^^^ -* `@ESadek-MO `_ updated CONTRIBUTING.md in line with the +* `@trexfeathers `_ updated CONTRIBUTING.md in line with the newer v5 SciTools CLA. `(PR#371) `_ * `@trexfeathers `_ added a pre-commit configuration. From 1d2232c698a0b8b0d4a145ba6c1a915bd133a5e2 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Fri, 30 Aug 2024 11:32:06 +0100 Subject: [PATCH 6/7] Update docs/ref/release_notes.rst Co-authored-by: Martin Yeo <40734014+trexfeathers@users.noreply.github.com> --- docs/ref/release_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index abbaa80b..293cffaf 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -86,7 +86,7 @@ Internal * `@HGWright `_ replaced setup.py with pyproject.toml. `(PR#408) `_ -* `@ESadek-MO `_ configured for MyPy checking via +* `@stephenworsley `_ configured for MyPy checking via pre-commit. `(PR#407) `_ * `@ESadek-MO `_ migrated CI testing from Cirrus to From 0d6690bf33cd8e2d76244cde0f5f8ff1935d2b97 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Fri, 30 Aug 2024 13:01:55 +0100 Subject: [PATCH 7/7] Further whatsnew updates --- docs/ref/release_notes.rst | 111 +++++++++++++++++++++++++++++-------- 1 file changed, 88 insertions(+), 23 deletions(-) diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index 293cffaf..deed099d 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -16,13 +16,16 @@ Features ^^^^^^^^ * `@abooton `_ added support for saving data on a Lambert Azimuthal Equal Area (LAEA) projection, as grid definition template 3.140. + `(ISSUE#344) `_, `(PR#343) `_ * `@trexfeathers `_, `@mo-marqh `_ and `@pp-mo `_ added support for production definition template 4.6, i.e. percentile forecasts. - `(PR#401) `_ + `(PR#401) `_, + `(PR#295) `_, + `(PR#271) `_ * `@pp-mo `_ expanded the use of the "GRIB_PARAM" attributes to GRIB1 loading, and documented it more thoroughly. @@ -32,15 +35,20 @@ Features * `@DPeterK `_ and `@trexfeathers `_ added saving support for grid definition template 20 - polar stereographic. + `(ISSUE#122) `_, `(PR#405) `_ -* `@pp-mo `_ made essential changes for compatibility with - Iris >= 3.10. - `(PR#463) `_ - Documentation ^^^^^^^^^^^^^ +* `@tkknight `_ fixed docs building on ReadTheDocs, and + enabled a test docs-build for each individual PR. + `(ISSUE#365) `_, + `(PR#366) `_ + +* `@tkknight `_ made docs builds treat warnings as errors. + `(PR#471) `_ + * `@pp-mo `_ reworked the main docs page to : headline basic load + save with Iris, rather than lower-level functions; better explain load-pairs and save-pairs usage; make all usage examples into @@ -48,7 +56,9 @@ Documentation `(ISSUE#398) `_, `(PR#402) `_ -* `@bjlittle `_ added the logo to README.md . +* `@bjlittle `_ updated the readme, replacing README.rst + with README.md and adding a logo . + `(PR#440) `_, `(PR#447) `_ * `@tkknight `_ fixed the display formatting of linux @@ -71,60 +81,108 @@ Dependencies as required for doctests. `(PR#413) `_ -* `@pp-mo `_ made compatible with Iris >= 3.10 . +* `@pp-mo `_ made essential changes for compatibility with + Iris >= 3.10. `(PR#463) `_ Internal ^^^^^^^^ * `@trexfeathers `_ updated CONTRIBUTING.md in line with the - newer v5 SciTools CLA. `(PR#371) `_ + newer v5 SciTools CLA. `(PR#371) `_ -* `@trexfeathers `_ added a pre-commit configuration. - `(PR#400) `_ +* `@pp-mo `_ updated an obsolete license header in one test. + `(PR#374) `_ -* `@HGWright `_ replaced setup.py with pyproject.toml. - `(PR#408) `_ +* `@trexfeathers `_ and + `@pp-mo `_ added a pre-commit configuration and got all + checks passing. + `(ISSUE#388) `_, + `(PR#400) `_, + `(PR#406) `_ + +* `@HGWright `_ and + `@trexfeathers `_ replaced setup.py with + pyproject.toml. + `(ISSUE#387) `_, + `(PR#408) `_, + `(PR#429) `_ * `@stephenworsley `_ configured for MyPy checking via - pre-commit. `(PR#407) `_ + pre-commit. + `(ISSUE#386) `_, + `(PR#407) `_ -* `@ESadek-MO `_ migrated CI testing from Cirrus to +* `@ESadek-MO `_ and + `@bjlittle `_ migrated CI testing from Cirrus to GitHub Actions. - `(PR#415) `_ + `(ISSUE#340) `_, + `(PR#415) `_, + `(PR#425) `_, + `(PR#432) `_ * `@trexfeathers `_ and `@HGWright `_ adopted Ruff for code style checking. - `(PR#430) `_, - `(PR#419) `_ + `(ISSUE#384) `_, + `(PR#430) `_, + `(PR#419) `_ * `@bjlittle `_ migrated the test runs from nose to pytest. - `(PR#420) `_ + `(ISSUE#253) `_, + `(ISSUE#412) `_, + `(PR#420) `_, + `(PR#424) `_ * `@stephenworsley `_ removed the now-redundant _iris_mercator_support.py. - `(PR#433) `_ + `(ISSUE#431) `_, + `(PR#433) `_, + `(PR#435) `_ * `@bjlittle `_ added build manifest checking in GHA. - `(PR#427) `_ + `(PR#427) `_, + `(PR#436) `_, + `(PR#441) `_ * `@bjlittle `_ added dependabot checking. `(PR#426) `_ +* `@bjlittle `_ removed 'wheel' dependency from build + system, as-per + `repo-review `_. + `(PR#437) `_ + +* `@bjlittle `_ fixed blacken-docs url in pre-commit, + as per + `repo-review `_. + `(PR#438) `_ + +* `@bjlittle `_ provided a custom per-commit.ci message, + as per + `repo-review `_. + `(PR#439) `_ + * `@pp-mo `_ removed obsolete workaround routines relating to older eccodes versions. + `(ISSUE#239) `_, `(PR#410) `_ * `@HGWright `_ implemented version handling with setuptools.scm . + `(ISSUE#418) `_, `(PR#444) `_ * `@bjlittle `_ moved the top-level ``./iris_grib`` folder to ``./src/iris_grib``, in line with modern practice, as per `repo-review `_. + `(ISSUE#421) `_, `(PR#450) `_ +* `@bjlittle `_ adopted .git-blame-ignore-revs to exclude + some very noisy PRs from file "blame" views + `(PR#452) `_ + * `@bjlittle `_ dropped Python 3.9 support and added 3.12, in accordance with `nep29 `_. `(PR#453) `_ @@ -137,21 +195,28 @@ Internal * `@bjlittle `_ added repository health checking with `repo-review `_ via pre-commit. + `(ISSUE#392) `_, `(PR#456) `_ * `@bjlittle `_ added a CODE_OF_CONDUCT.md . `(PR#460) `_ -* `@tkknight `_ made docs builds treat warnings as errors. - `(PR#471) `_ +* `@bjlittle `_ aligned .gitignore with a suggested + standard form + `(PR#461) `_ + +* `@bjlittle `_ fixed some spelling errors to satisfy + codespell + `(PR#479) `_ * `@githubalexliu `_ fixed a problem with the MyPy checking. + `(ISSUE#496) `_, `(PR#497) `_ * `@trexfeathers `_ aligned the pre-commit-config with the SciTools "reference" version. - `(PR#464) `_, + `(PR#464) `_, New Contributors