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. diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index b27c08b4..deed099d 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -10,49 +10,227 @@ 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. + `(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 document it more thoroughly. + attributes to GRIB1 loading, and documented it more thoroughly. `(ISSUE#330) `_, `(PR#402) `_ * `@DPeterK `_ and `@trexfeathers `_ added saving support for grid definition template 20 - polar stereographic. + `(ISSUE#122) `_, `(PR#405) `_ 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 doctests. - `(ISSUE#398) `_ + `(ISSUE#398) `_, + `(PR#402) `_ + +* `@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 + 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 : 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) `_ +* `@bjlittle `_ added iris-sample-data as a dependency, + as required for doctests. + `(PR#413) `_ + +* `@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) `_ + +* `@pp-mo `_ updated an obsolete license header in one test. + `(PR#374) `_ + +* `@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. + `(ISSUE#386) `_, + `(PR#407) `_ + +* `@ESadek-MO `_ and + `@bjlittle `_ migrated CI testing from Cirrus to + GitHub Actions. + `(ISSUE#340) `_, + `(PR#415) `_, + `(PR#425) `_, + `(PR#432) `_ + +* `@trexfeathers `_ and + `@HGWright `_ adopted Ruff for code style checking. + `(ISSUE#384) `_, + `(PR#430) `_, + `(PR#419) `_ + +* `@bjlittle `_ migrated the test runs from + nose to pytest. + `(ISSUE#253) `_, + `(ISSUE#412) `_, + `(PR#420) `_, + `(PR#424) `_ + +* `@stephenworsley `_ removed the now-redundant + _iris_mercator_support.py. + `(ISSUE#431) `_, + `(PR#433) `_, + `(PR#435) `_ + +* `@bjlittle `_ added build manifest checking in GHA. + `(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) `_ + +* `@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. + `(ISSUE#392) `_, + `(PR#456) `_ + +* `@bjlittle `_ added a CODE_OF_CONDUCT.md . + `(PR#460) `_ + +* `@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) `_, + + +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 ------------------------------- @@ -130,6 +308,7 @@ Dependencies New Contributors ^^^^^^^^^^^^^^^^ Welcome to + * `@s-boardman `_ * `@david-bentley `_ * `@valeriupredoi `_