Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Whatsnew updates for v0.20.0 . #528

Merged
merged 7 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
195 changes: 187 additions & 8 deletions docs/ref/release_notes.rst
trexfeathers marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/abooton>`_ added support for saving data on a
Lambert Azimuthal Equal Area (LAEA) projection, as grid definition template 3.140.
`(ISSUE#344) <https://github.com/SciTools/iris-grib/issues/344>`_,
`(PR#343) <https://github.com/SciTools/iris-grib/pull/343>`_

* `@trexfeathers <https://github.com/trexfeathers>`_,
`@mo-marqh <https://github.com/mo-marqh>`_ and
`@pp-mo <https://github.com/pp-mo>`_ added support for production definition template
4.6, i.e. percentile forecasts.
`(PR#401) <https://github.com/SciTools/iris-grib/pull/401>`_
`(PR#401) <https://github.com/SciTools/iris-grib/pull/401>`_,
`(PR#295) <https://github.com/SciTools/iris-grib/pull/295>`_,
`(PR#271) <https://github.com/SciTools/iris-grib/pull/271>`_

* `@pp-mo <https://github.com/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) <https://github.com/SciTools/iris-grib/issues/330>`_,
`(PR#402) <https://github.com/SciTools/iris-grib/pull/402>`_

* `@DPeterK <https://github.com/DPeterK>`_ and
`@trexfeathers <https://github.com/trexfeathers>`_ added saving support for
grid definition template 20 - polar stereographic.
`(ISSUE#122) <https://github.com/SciTools/iris-grib/issues/122>`_,
`(PR#405) <https://github.com/SciTools/iris-grib/pull/405>`_


Documentation
^^^^^^^^^^^^^
* `@tkknight <https://github.com/tkknight>`_ fixed docs building on ReadTheDocs, and
enabled a test docs-build for each individual PR.
`(ISSUE#365) <https://github.com/SciTools/iris-grib/issues/365>`_,
`(PR#366) <https://github.com/SciTools/iris-grib/pull/366>`_

* `@tkknight <https://github.com/tkknight>`_ made docs builds treat warnings as errors.
`(PR#471) <https://github.com/SciTools/iris-grib/pull/471>`_

* `@pp-mo <https://github.com/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) <https://github.com/SciTools/iris-grib/issues/398>`_
`(ISSUE#398) <https://github.com/SciTools/iris-grib/issues/398>`_,
`(PR#402) <https://github.com/SciTools/iris-grib/pull/402>`_

* `@bjlittle <https://github.com/bjlittle>`_ updated the readme, replacing README.rst
with README.md and adding a logo .
`(PR#440) <https://github.com/SciTools/iris-grib/pull/440>`_,
`(PR#447) <https://github.com/SciTools/iris-grib/pull/447>`_

* `@tkknight <https://github.com/tkknight>`_ fixed the display formatting of linux
commands.
`(PR#455) <https://github.com/SciTools/iris-grib/pull/455>`_


Dependencies
^^^^^^^^^^^^
* `@bjlittle <https://github.com/bjlittle>`_ migrated to ``pytest``.
`(PR#420) <https://github.com/SciTools/iris-grib/pull/420>`_

* `@pp-mo <https://github.com/pp-mo>`_ enabled support for
`eccodes v2.36 <https://confluence.ecmwf.int/display/ECC/ecCodes+version+2.36.0+released>`_.
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) <https://github.com/SciTools/iris-grib/issues/504>`_

* `@bjlittle <https://github.com/bjlittle>`_ added iris-sample-data as a dependency,
as required for doctests.
`(PR#413) <https://github.com/SciTools/iris-grib/pull/413>`_

* `@pp-mo <https://github.com/pp-mo>`_ made essential changes for compatibility with
Iris >= 3.10.
`(PR#463) <https://github.com/SciTools/iris-grib/pull/463>`_


Internal
^^^^^^^^
* `@trexfeathers <https://github.com/trexfeathers>`_ updated CONTRIBUTING.md in line with the
newer v5 SciTools CLA. `(PR#371) <https://github.com/SciTools/iris-grib/pull/371>`_

* `@pp-mo <https://github.com/pp-mo>`_ updated an obsolete license header in one test.
`(PR#374) <https://github.com/SciTools/iris-grib/pull/374>`_

* `@trexfeathers <https://github.com/trexfeathers>`_ and
`@pp-mo <https://github.com/pp-mo>`_ added a pre-commit configuration and got all
checks passing.
`(ISSUE#388) <https://github.com/SciTools/iris-grib/issues/388>`_,
`(PR#400) <https://github.com/SciTools/iris-grib/pull/400>`_,
`(PR#406) <https://github.com/SciTools/iris-grib/pull/406>`_

* `@HGWright <https://github.com/HGWright>`_ and
`@trexfeathers <https://github.com/trexfeathers>`_ replaced setup.py with
pyproject.toml.
`(ISSUE#387) <https://github.com/SciTools/iris-grib/issues/387>`_,
`(PR#408) <https://github.com/SciTools/iris-grib/pull/408>`_,
`(PR#429) <https://github.com/SciTools/iris-grib/pull/429>`_

* `@stephenworsley <https://github.com/stephenworsley>`_ configured for MyPy checking via
pre-commit.
`(ISSUE#386) <https://github.com/SciTools/iris-grib/issues/386>`_,
`(PR#407) <https://github.com/SciTools/iris-grib/pull/407>`_

* `@ESadek-MO <https://github.com/ESadek-MO>`_ and
`@bjlittle <https://github.com/bjlittle>`_ migrated CI testing from Cirrus to
GitHub Actions.
`(ISSUE#340) <https://github.com/SciTools/iris-grib/issues/340>`_,
`(PR#415) <https://github.com/SciTools/iris-grib/pull/415>`_,
`(PR#425) <https://github.com/SciTools/iris-grib/pull/425>`_,
`(PR#432) <https://github.com/SciTools/iris-grib/pull/432>`_

* `@trexfeathers <https://github.com/trexfeathers>`_ and
`@HGWright <https://github.com/HGWright>`_ adopted Ruff for code style checking.
`(ISSUE#384) <https://github.com/SciTools/iris-grib/issues/384>`_,
`(PR#430) <https://github.com/SciTools/iris-grib/pull/430>`_,
`(PR#419) <https://github.com/SciTools/iris-grib/pull/419>`_

* `@bjlittle <https://github.com/bjlittle>`_ migrated the test runs from
nose to pytest.
`(ISSUE#253) <https://github.com/SciTools/iris-grib/issues/253>`_,
`(ISSUE#412) <https://github.com/SciTools/iris-grib/issues/412>`_,
`(PR#420) <https://github.com/SciTools/iris-grib/pull/420>`_,
`(PR#424) <https://github.com/SciTools/iris-grib/pull/424>`_

* `@stephenworsley <https://github.com/stephenworsley>`_ removed the now-redundant
_iris_mercator_support.py.
`(ISSUE#431) <https://github.com/SciTools/iris-grib/issues/431>`_,
`(PR#433) <https://github.com/SciTools/iris-grib/pull/433>`_,
`(PR#435) <https://github.com/SciTools/iris-grib/pull/435>`_

* `@bjlittle <https://github.com/bjlittle>`_ added build manifest checking in GHA.
`(PR#427) <https://github.com/SciTools/iris-grib/pull/427>`_,
`(PR#436) <https://github.com/SciTools/iris-grib/pull/436>`_,
`(PR#441) <https://github.com/SciTools/iris-grib/pull/441>`_

* `@bjlittle <https://github.com/bjlittle>`_ added dependabot checking.
`(PR#426) <https://github.com/SciTools/iris-grib/pull/426>`_

* `@bjlittle <https://github.com/bjlittle>`_ removed 'wheel' dependency from build
system, as-per
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_.
`(PR#437) <https://github.com/SciTools/iris-grib/pull/437>`_

* `@bjlittle <https://github.com/bjlittle>`_ fixed blacken-docs url in pre-commit,
as per
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_.
`(PR#438) <https://github.com/SciTools/iris-grib/pull/438>`_

* `@bjlittle <https://github.com/bjlittle>`_ provided a custom per-commit.ci message,
as per
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_.
`(PR#439) <https://github.com/SciTools/iris-grib/pull/439>`_

* `@pp-mo <https://github.com/pp-mo>`_ removed obsolete workaround routines relating to
older eccodes versions.
`(ISSUE#239) <https://github.com/SciTools/iris-grib/issues/239>`_,
`(PR#410) <https://github.com/SciTools/iris-grib/pull/410>`_

* `@HGWright <https://github.com/HGWright>`_ implemented version handling with
setuptools.scm .
`(ISSUE#418) <https://github.com/SciTools/iris-grib/issues/418>`_,
`(PR#444) <https://github.com/SciTools/iris-grib/pull/444>`_

* `@bjlittle <https://github.com/bjlittle>`_ moved the top-level ``./iris_grib`` folder
to ``./src/iris_grib``, in line with modern practice, as per
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_.
`(ISSUE#421) <https://github.com/SciTools/iris-grib/issues/421>`_,
`(PR#450) <https://github.com/SciTools/iris-grib/pull/450>`_

* `@bjlittle <https://github.com/bjlittle>`_ adopted .git-blame-ignore-revs to exclude
some very noisy PRs from file "blame" views
`(PR#452) <https://github.com/SciTools/iris-grib/pull/452>`_

* `@bjlittle <https://github.com/bjlittle>`_ dropped Python 3.9 support and added 3.12,
in accordance with `nep29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_.
`(PR#453) <https://github.com/SciTools/iris-grib/pull/453>`_

* `@bjlittle <https://github.com/bjlittle>`_ updated all optional dependency
requirements, and added codecov support.
`(PR#454) <https://github.com/SciTools/iris-grib/pull/454>`_,
`(PR#459) <https://github.com/SciTools/iris-grib/pull/459>`_

* `@bjlittle <https://github.com/bjlittle>`_ added repository health checking with
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_
via pre-commit.
`(ISSUE#392) <https://github.com/SciTools/iris-grib/issues/392>`_,
`(PR#456) <https://github.com/SciTools/iris-grib/pull/456>`_

* `@bjlittle <https://github.com/bjlittle>`_ added a CODE_OF_CONDUCT.md .
`(PR#460) <https://github.com/SciTools/iris-grib/pull/460>`_

* `@bjlittle <https://github.com/bjlittle>`_ aligned .gitignore with a suggested
standard form
`(PR#461) <https://github.com/SciTools/iris-grib/pull/461>`_

* `@bjlittle <https://github.com/bjlittle>`_ fixed some spelling errors to satisfy
codespell
`(PR#479) <https://github.com/SciTools/iris-grib/pull/479>`_

* `@githubalexliu <https://github.com/githubalexliu>`_ fixed a problem with the MyPy
checking.
`(ISSUE#496) <https://github.com/SciTools/iris-grib/issues/496>`_,
`(PR#497) <https://github.com/SciTools/iris-grib/pull/497>`_

* `@trexfeathers <https://github.com/trexfeathers>`_ aligned the pre-commit-config with
the SciTools "reference" version.
`(PR#464) <https://github.com/SciTools/iris-grib/pull/464>`_,


New Contributors
^^^^^^^^^^^^^^^^
Welcome to

* `@abooton <https://github.com/abooton>`_
* `@githubalexliu <https://github.com/githubalexliu>`_
* `@stephenworsley <https://github.com/stephenworsley>`_
* `@tkknight <https://github.com/tkknight>`_ fixed the display formatting of linux
* `@DPeterK <https://github.com/DPeterK>`_
* `@ESadek-MO <https://github.com/ESadek-MO>`_
* `@HGWright <https://github.com/HGWright>`_


What's new in iris-grib v0.19.1
-------------------------------
Expand Down Expand Up @@ -130,6 +308,7 @@ Dependencies
New Contributors
^^^^^^^^^^^^^^^^
Welcome to

* `@s-boardman <https://github.com/s-boardman>`_
* `@david-bentley <https://github.com/david-bentley>`_
* `@valeriupredoi <https://github.com/valeriupredoi>`_
Expand Down
Loading