Skip to content

Commit ed1964b

Browse files
pp-motrexfeathers
andauthored
Whatsnew updates for v0.20.0 . (#528)
* Whatsnew updates for v0.20.0 . * Further improvements * Adjust version on main page. * Fix issue/pr ref * Update docs/ref/release_notes.rst Co-authored-by: Martin Yeo <[email protected]> * Update docs/ref/release_notes.rst Co-authored-by: Martin Yeo <[email protected]> * Further whatsnew updates --------- Co-authored-by: Martin Yeo <[email protected]>
1 parent 83fa252 commit ed1964b

File tree

2 files changed

+189
-10
lines changed

2 files changed

+189
-10
lines changed

docs/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Iris-grib v0.20 (unreleased)
7-
============================
6+
Iris-grib v0.20
7+
===============
88

99
The library ``iris-grib`` provides functionality for converting between weather and
1010
climate datasets that are stored as GRIB files and Iris :class:`~iris.cube.Cube`\s.

docs/ref/release_notes.rst

+187-8
Original file line numberDiff line numberDiff line change
@@ -10,49 +10,227 @@ What's new in iris-grib v0.20.0
1010
-------------------------------
1111

1212
:Release: 0.20.0
13-
:Date: [unreleased]
13+
:Date: 29 August 2024
1414

1515
Features
1616
^^^^^^^^
17+
* `@abooton <https://github.com/abooton>`_ added support for saving data on a
18+
Lambert Azimuthal Equal Area (LAEA) projection, as grid definition template 3.140.
19+
`(ISSUE#344) <https://github.com/SciTools/iris-grib/issues/344>`_,
20+
`(PR#343) <https://github.com/SciTools/iris-grib/pull/343>`_
21+
1722
* `@trexfeathers <https://github.com/trexfeathers>`_,
1823
`@mo-marqh <https://github.com/mo-marqh>`_ and
1924
`@pp-mo <https://github.com/pp-mo>`_ added support for production definition template
2025
4.6, i.e. percentile forecasts.
21-
`(PR#401) <https://github.com/SciTools/iris-grib/pull/401>`_
26+
`(PR#401) <https://github.com/SciTools/iris-grib/pull/401>`_,
27+
`(PR#295) <https://github.com/SciTools/iris-grib/pull/295>`_,
28+
`(PR#271) <https://github.com/SciTools/iris-grib/pull/271>`_
2229

2330
* `@pp-mo <https://github.com/pp-mo>`_ expanded the use of the "GRIB_PARAM"
24-
attributes to GRIB1 loading, and document it more thoroughly.
31+
attributes to GRIB1 loading, and documented it more thoroughly.
2532
`(ISSUE#330) <https://github.com/SciTools/iris-grib/issues/330>`_,
2633
`(PR#402) <https://github.com/SciTools/iris-grib/pull/402>`_
2734

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

3341

3442
Documentation
3543
^^^^^^^^^^^^^
44+
* `@tkknight <https://github.com/tkknight>`_ fixed docs building on ReadTheDocs, and
45+
enabled a test docs-build for each individual PR.
46+
`(ISSUE#365) <https://github.com/SciTools/iris-grib/issues/365>`_,
47+
`(PR#366) <https://github.com/SciTools/iris-grib/pull/366>`_
48+
49+
* `@tkknight <https://github.com/tkknight>`_ made docs builds treat warnings as errors.
50+
`(PR#471) <https://github.com/SciTools/iris-grib/pull/471>`_
51+
3652
* `@pp-mo <https://github.com/pp-mo>`_ reworked the main docs page to :
3753
headline basic load + save with Iris, rather than lower-level functions;
3854
better explain load-pairs and save-pairs usage; make all usage examples into
3955
doctests.
40-
`(ISSUE#398) <https://github.com/SciTools/iris-grib/issues/398>`_
56+
`(ISSUE#398) <https://github.com/SciTools/iris-grib/issues/398>`_,
57+
`(PR#402) <https://github.com/SciTools/iris-grib/pull/402>`_
58+
59+
* `@bjlittle <https://github.com/bjlittle>`_ updated the readme, replacing README.rst
60+
with README.md and adding a logo .
61+
`(PR#440) <https://github.com/SciTools/iris-grib/pull/440>`_,
62+
`(PR#447) <https://github.com/SciTools/iris-grib/pull/447>`_
63+
64+
* `@tkknight <https://github.com/tkknight>`_ fixed the display formatting of linux
65+
commands.
66+
`(PR#455) <https://github.com/SciTools/iris-grib/pull/455>`_
67+
4168

4269
Dependencies
4370
^^^^^^^^^^^^
44-
* `@bjlittle <https://github.com/bjlittle>`_ migrated to ``pytest``.
45-
`(PR#420) <https://github.com/SciTools/iris-grib/pull/420>`_
46-
4771
* `@pp-mo <https://github.com/pp-mo>`_ enabled support for
4872
`eccodes v2.36 <https://confluence.ecmwf.int/display/ECC/ecCodes+version+2.36.0+released>`_.
4973
Eccodes v2.36 has implemented some backwards incompatible changes :
5074
The ``indicatorOfUnitOfTimeRange`` key was removed, to be replaced with
51-
``indicatorOfUnitForForecastTime`` (but only in GRIB v2 messages only, not GRIB 1);
75+
``indicatorOfUnitForForecastTime`` (but only in GRIB v2 messages, not GRIB 1);
5276
and the ``iScansPositively`` and ``jScansPositively`` keys became read-only.
5377
The resulting changes mean **we now only support eccodes >=2.33**.
5478
`(PR#504) <https://github.com/SciTools/iris-grib/issues/504>`_
5579

80+
* `@bjlittle <https://github.com/bjlittle>`_ added iris-sample-data as a dependency,
81+
as required for doctests.
82+
`(PR#413) <https://github.com/SciTools/iris-grib/pull/413>`_
83+
84+
* `@pp-mo <https://github.com/pp-mo>`_ made essential changes for compatibility with
85+
Iris >= 3.10.
86+
`(PR#463) <https://github.com/SciTools/iris-grib/pull/463>`_
87+
88+
89+
Internal
90+
^^^^^^^^
91+
* `@trexfeathers <https://github.com/trexfeathers>`_ updated CONTRIBUTING.md in line with the
92+
newer v5 SciTools CLA. `(PR#371) <https://github.com/SciTools/iris-grib/pull/371>`_
93+
94+
* `@pp-mo <https://github.com/pp-mo>`_ updated an obsolete license header in one test.
95+
`(PR#374) <https://github.com/SciTools/iris-grib/pull/374>`_
96+
97+
* `@trexfeathers <https://github.com/trexfeathers>`_ and
98+
`@pp-mo <https://github.com/pp-mo>`_ added a pre-commit configuration and got all
99+
checks passing.
100+
`(ISSUE#388) <https://github.com/SciTools/iris-grib/issues/388>`_,
101+
`(PR#400) <https://github.com/SciTools/iris-grib/pull/400>`_,
102+
`(PR#406) <https://github.com/SciTools/iris-grib/pull/406>`_
103+
104+
* `@HGWright <https://github.com/HGWright>`_ and
105+
`@trexfeathers <https://github.com/trexfeathers>`_ replaced setup.py with
106+
pyproject.toml.
107+
`(ISSUE#387) <https://github.com/SciTools/iris-grib/issues/387>`_,
108+
`(PR#408) <https://github.com/SciTools/iris-grib/pull/408>`_,
109+
`(PR#429) <https://github.com/SciTools/iris-grib/pull/429>`_
110+
111+
* `@stephenworsley <https://github.com/stephenworsley>`_ configured for MyPy checking via
112+
pre-commit.
113+
`(ISSUE#386) <https://github.com/SciTools/iris-grib/issues/386>`_,
114+
`(PR#407) <https://github.com/SciTools/iris-grib/pull/407>`_
115+
116+
* `@ESadek-MO <https://github.com/ESadek-MO>`_ and
117+
`@bjlittle <https://github.com/bjlittle>`_ migrated CI testing from Cirrus to
118+
GitHub Actions.
119+
`(ISSUE#340) <https://github.com/SciTools/iris-grib/issues/340>`_,
120+
`(PR#415) <https://github.com/SciTools/iris-grib/pull/415>`_,
121+
`(PR#425) <https://github.com/SciTools/iris-grib/pull/425>`_,
122+
`(PR#432) <https://github.com/SciTools/iris-grib/pull/432>`_
123+
124+
* `@trexfeathers <https://github.com/trexfeathers>`_ and
125+
`@HGWright <https://github.com/HGWright>`_ adopted Ruff for code style checking.
126+
`(ISSUE#384) <https://github.com/SciTools/iris-grib/issues/384>`_,
127+
`(PR#430) <https://github.com/SciTools/iris-grib/pull/430>`_,
128+
`(PR#419) <https://github.com/SciTools/iris-grib/pull/419>`_
129+
130+
* `@bjlittle <https://github.com/bjlittle>`_ migrated the test runs from
131+
nose to pytest.
132+
`(ISSUE#253) <https://github.com/SciTools/iris-grib/issues/253>`_,
133+
`(ISSUE#412) <https://github.com/SciTools/iris-grib/issues/412>`_,
134+
`(PR#420) <https://github.com/SciTools/iris-grib/pull/420>`_,
135+
`(PR#424) <https://github.com/SciTools/iris-grib/pull/424>`_
136+
137+
* `@stephenworsley <https://github.com/stephenworsley>`_ removed the now-redundant
138+
_iris_mercator_support.py.
139+
`(ISSUE#431) <https://github.com/SciTools/iris-grib/issues/431>`_,
140+
`(PR#433) <https://github.com/SciTools/iris-grib/pull/433>`_,
141+
`(PR#435) <https://github.com/SciTools/iris-grib/pull/435>`_
142+
143+
* `@bjlittle <https://github.com/bjlittle>`_ added build manifest checking in GHA.
144+
`(PR#427) <https://github.com/SciTools/iris-grib/pull/427>`_,
145+
`(PR#436) <https://github.com/SciTools/iris-grib/pull/436>`_,
146+
`(PR#441) <https://github.com/SciTools/iris-grib/pull/441>`_
147+
148+
* `@bjlittle <https://github.com/bjlittle>`_ added dependabot checking.
149+
`(PR#426) <https://github.com/SciTools/iris-grib/pull/426>`_
150+
151+
* `@bjlittle <https://github.com/bjlittle>`_ removed 'wheel' dependency from build
152+
system, as-per
153+
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_.
154+
`(PR#437) <https://github.com/SciTools/iris-grib/pull/437>`_
155+
156+
* `@bjlittle <https://github.com/bjlittle>`_ fixed blacken-docs url in pre-commit,
157+
as per
158+
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_.
159+
`(PR#438) <https://github.com/SciTools/iris-grib/pull/438>`_
160+
161+
* `@bjlittle <https://github.com/bjlittle>`_ provided a custom per-commit.ci message,
162+
as per
163+
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_.
164+
`(PR#439) <https://github.com/SciTools/iris-grib/pull/439>`_
165+
166+
* `@pp-mo <https://github.com/pp-mo>`_ removed obsolete workaround routines relating to
167+
older eccodes versions.
168+
`(ISSUE#239) <https://github.com/SciTools/iris-grib/issues/239>`_,
169+
`(PR#410) <https://github.com/SciTools/iris-grib/pull/410>`_
170+
171+
* `@HGWright <https://github.com/HGWright>`_ implemented version handling with
172+
setuptools.scm .
173+
`(ISSUE#418) <https://github.com/SciTools/iris-grib/issues/418>`_,
174+
`(PR#444) <https://github.com/SciTools/iris-grib/pull/444>`_
175+
176+
* `@bjlittle <https://github.com/bjlittle>`_ moved the top-level ``./iris_grib`` folder
177+
to ``./src/iris_grib``, in line with modern practice, as per
178+
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_.
179+
`(ISSUE#421) <https://github.com/SciTools/iris-grib/issues/421>`_,
180+
`(PR#450) <https://github.com/SciTools/iris-grib/pull/450>`_
181+
182+
* `@bjlittle <https://github.com/bjlittle>`_ adopted .git-blame-ignore-revs to exclude
183+
some very noisy PRs from file "blame" views
184+
`(PR#452) <https://github.com/SciTools/iris-grib/pull/452>`_
185+
186+
* `@bjlittle <https://github.com/bjlittle>`_ dropped Python 3.9 support and added 3.12,
187+
in accordance with `nep29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_.
188+
`(PR#453) <https://github.com/SciTools/iris-grib/pull/453>`_
189+
190+
* `@bjlittle <https://github.com/bjlittle>`_ updated all optional dependency
191+
requirements, and added codecov support.
192+
`(PR#454) <https://github.com/SciTools/iris-grib/pull/454>`_,
193+
`(PR#459) <https://github.com/SciTools/iris-grib/pull/459>`_
194+
195+
* `@bjlittle <https://github.com/bjlittle>`_ added repository health checking with
196+
`repo-review <https://learn.scientific-python.org/development/guides/repo-review/>`_
197+
via pre-commit.
198+
`(ISSUE#392) <https://github.com/SciTools/iris-grib/issues/392>`_,
199+
`(PR#456) <https://github.com/SciTools/iris-grib/pull/456>`_
200+
201+
* `@bjlittle <https://github.com/bjlittle>`_ added a CODE_OF_CONDUCT.md .
202+
`(PR#460) <https://github.com/SciTools/iris-grib/pull/460>`_
203+
204+
* `@bjlittle <https://github.com/bjlittle>`_ aligned .gitignore with a suggested
205+
standard form
206+
`(PR#461) <https://github.com/SciTools/iris-grib/pull/461>`_
207+
208+
* `@bjlittle <https://github.com/bjlittle>`_ fixed some spelling errors to satisfy
209+
codespell
210+
`(PR#479) <https://github.com/SciTools/iris-grib/pull/479>`_
211+
212+
* `@githubalexliu <https://github.com/githubalexliu>`_ fixed a problem with the MyPy
213+
checking.
214+
`(ISSUE#496) <https://github.com/SciTools/iris-grib/issues/496>`_,
215+
`(PR#497) <https://github.com/SciTools/iris-grib/pull/497>`_
216+
217+
* `@trexfeathers <https://github.com/trexfeathers>`_ aligned the pre-commit-config with
218+
the SciTools "reference" version.
219+
`(PR#464) <https://github.com/SciTools/iris-grib/pull/464>`_,
220+
221+
222+
New Contributors
223+
^^^^^^^^^^^^^^^^
224+
Welcome to
225+
226+
* `@abooton <https://github.com/abooton>`_
227+
* `@githubalexliu <https://github.com/githubalexliu>`_
228+
* `@stephenworsley <https://github.com/stephenworsley>`_
229+
* `@tkknight <https://github.com/tkknight>`_ fixed the display formatting of linux
230+
* `@DPeterK <https://github.com/DPeterK>`_
231+
* `@ESadek-MO <https://github.com/ESadek-MO>`_
232+
* `@HGWright <https://github.com/HGWright>`_
233+
56234

57235
What's new in iris-grib v0.19.1
58236
-------------------------------
@@ -130,6 +308,7 @@ Dependencies
130308
New Contributors
131309
^^^^^^^^^^^^^^^^
132310
Welcome to
311+
133312
* `@s-boardman <https://github.com/s-boardman>`_
134313
* `@david-bentley <https://github.com/david-bentley>`_
135314
* `@valeriupredoi <https://github.com/valeriupredoi>`_

0 commit comments

Comments
 (0)