Skip to content

Commit eda7728

Browse files
committed
update CHANGELOG.rst
1 parent e4d4146 commit eda7728

File tree

1 file changed

+16
-44
lines changed

1 file changed

+16
-44
lines changed

CHANGELOG.rst

Lines changed: 16 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ What's New
1414
# cut border when saving (for maps)
1515
mpl.rcParams["savefig.bbox"] = "tight"
1616
17+
18+
climpred v2.4.0 (2023-11-09)
19+
============================
20+
1721
Internals/Minor Fixes
1822
---------------------
1923
- Fix broken GEFS link (:pr:`807`) `Trevor Gamblin`_
@@ -28,9 +32,7 @@ climpred v2.3.0 (2022-11-25)
2832
============================
2933

3034
.. note::
31-
As both maintainers moved out of academia into industry,
32-
this will be probably the last release for a while.
33-
If you are interested in maintaining climpred, please ping us.
35+
As both maintainers moved out of academia into industry, this will be probably the last release for a while. If you are interested in maintaining climpred, please ping us.
3436

3537
Bug Fixes
3638
---------
@@ -73,7 +75,6 @@ New Features
7375
:py:func:`climpred.utils.convert_valid_time_lead_to_init_lead`.
7476
(:issue:`774`, :pr:`775`, :pr:`783`) `Aaron Spring`_.
7577

76-
7778
Internals/Minor Fixes
7879
---------------------
7980
- Refactor ``asv`` benchmarking. Add ``run-benchmarks`` label to ``PR`` to run ``asv``
@@ -278,10 +279,7 @@ New Features
278279
climpred v2.1.5 (2021-08-12)
279280
============================
280281

281-
While ``climpred`` has used in the
282-
`ASP summer colloquium 2021 <https://asp.ucar.edu/asp-colloquia>`_,
283-
many new features in :py:meth:`.HindcastEnsemble.remove_bias` were
284-
implemented.
282+
While ``climpred`` has used in the `ASP summer colloquium 2021 <https://asp.ucar.edu/asp-colloquia>`_, many new features in :py:meth:`.HindcastEnsemble.remove_bias` were implemented.
285283

286284
Breaking changes
287285
----------------
@@ -338,7 +336,6 @@ New Features
338336
(:issue:`509`, :pr:`658`) `Aaron Spring`_.
339337
- Implement ``PredictionEnsemble.chunks``. (:pr:`658`) `Aaron Spring`_.
340338

341-
342339
Documentation
343340
-------------
344341
- Speed up `ENSO monthly example <examples/monseas/monthly-enso-subx-example.ipynb>`_
@@ -398,7 +395,6 @@ New Features
398395
``coords``, ``nbytes``, ``equals``, ``identical``, ``__iter__``, ``__len__``,
399396
``__contains__``, ``__delitem__``. (:issue:`568`, :pr:`632`) `Aaron Spring`_.
400397

401-
402398
Documentation
403399
-------------
404400
- Add `documentation page about publicly available initialized datasets and
@@ -434,9 +430,6 @@ Internals/Minor Fixes
434430
climpred v2.1.3 (2021-03-23)
435431
============================
436432

437-
Breaking changes
438-
----------------
439-
440433
New Features
441434
------------
442435
- :py:meth:`.HindcastEnsemble.verify`,
@@ -520,15 +513,7 @@ climpred v2.1.1 (2020-10-13)
520513

521514
Breaking changes
522515
----------------
523-
524-
This version introduces a lot of breaking changes. We are trying to overhaul
525-
``climpred`` to have an intuitive API that also forces users to think about methodology
526-
choices when running functions. The main breaking changes we introduced are for
527-
:py:meth:`.HindcastEnsemble.verify` and
528-
:py:meth:`.PerfectModelEnsemble.verify`. Now, instead of assuming
529-
defaults for most keywords, we require the user to define ``metric``, ``comparison``,
530-
``dim``, and ``alignment`` (for hindcast systems). We also require users to designate
531-
the number of ``iterations`` for bootstrapping.
516+
This version introduces a lot of breaking changes. We are trying to overhaul ``climpred`` to have an intuitive API that also forces users to think about methodology choices when running functions. The main breaking changes we introduced are for :py:meth:`.HindcastEnsemble.verify` and :py:meth:`.PerfectModelEnsemble.verify`. Now, instead of assuming defaults for most keywords, we require the user to define ``metric``, ``comparison``, ``dim``, and ``alignment`` (for hindcast systems). We also require users to designate the number of ``iterations`` for bootstrapping.
532517

533518
- User now has to designate number of iterations with ``iterations=...`` in
534519
:py:meth:`.HindcastEnsemble.bootstrap` (:issue:`384`, :pr:`436`)
@@ -564,14 +549,7 @@ the number of ``iterations`` for bootstrapping.
564549

565550
New Features
566551
------------
567-
568-
This release is accompanied by a bunch of new features. Math operations can now be used
569-
with our :py:class:`.PredictionEnsemble` objects and their variables
570-
can be sub-selected. Users can now quick plot time series forecasts with these objects.
571-
Bootstrapping is available for :py:class:`.HindcastEnsemble`. Spatial
572-
dimensions can be passed to metrics to do things like pattern correlation. New metrics
573-
have been implemented based on Contingency tables. We now include an early version
574-
of bias removal for :py:class:`.HindcastEnsemble`.
552+
This release is accompanied by a bunch of new features. Math operations can now be used with our :py:class:`.PredictionEnsemble` objects and their variables can be sub-selected. Users can now quick plot time series forecasts with these objects. Bootstrapping is available for :py:class:`.HindcastEnsemble`. Spatial dimensions can be passed to metrics to do things like pattern correlation. New metrics have been implemented based on Contingency tables. We now include an early version of bias removal for :py:class:`.HindcastEnsemble`.
575553

576554
- Use math operations like ``+-*/`` with :py:class:`.HindcastEnsemble`
577555
and :py:class:`.PerfectModelEnsemble`. See
@@ -626,9 +604,8 @@ of bias removal for :py:class:`.HindcastEnsemble`.
626604
respect to observations. See `example <bias_removal.html>`__.
627605
(:pr:`389`, :pr:`443`, :pr:`459`) `Aaron Spring`_ and `Riley X. Brady`_.
628606

629-
Deprecated
630-
----------
631-
607+
Depreciated
608+
-----------
632609
- ``spatial_smoothing_xrcoarsen`` no longer used for spatial smoothing.
633610
(:pr:`391`) `Aaron Spring`_.
634611
- ``compute_metric``, ``compute_uninitialized`` and ``compute_persistence`` no longer
@@ -641,7 +618,6 @@ Deprecated
641618

642619
Bug Fixes
643620
---------
644-
645621
- :py:meth:`.PredictionEnsemble.verify` and
646622
:py:meth:`.PredictionEnsemble.bootstrap` now accept
647623
``metric_kwargs``. (:pr:`387`) `Aaron Spring`_.
@@ -700,14 +676,12 @@ climpred v2.1.0 (2020-06-08)
700676

701677
Breaking Changes
702678
----------------
703-
704679
- Keyword ``bootstrap`` has been replaced with ``iterations``. We feel that this more
705680
accurately describes the argument, since "bootstrap" is really the process as a whole.
706681
(:pr:`354`) `Aaron Spring`_.
707682

708683
New Features
709684
------------
710-
711685
- :py:class:`.HindcastEnsemble` and
712686
:py:class:`.PerfectModelEnsemble` now use an HTML representation,
713687
following the more recent versions of ``xarray``. (:pr:`371`) `Aaron Spring`_.
@@ -743,11 +717,7 @@ New Features
743717

744718
Performance
745719
-----------
746-
747-
The major change for this release is a dramatic speedup in bootstrapping functions, led
748-
by `Aaron Spring`_. We focused on scalability with ``dask`` and found many places we
749-
could compute skill simultaneously over all bootstrapped ensemble members rather than
750-
at each iteration.
720+
The major change for this release is a dramatic speedup in bootstrapping functions, led by `Aaron Spring`_. We focused on scalability with ``dask`` and found many places we could compute skill simultaneously over all bootstrapped ensemble members rather than at each iteration.
751721

752722
- Bootstrapping uninitialized skill in the perfect model framework is now sped up
753723
significantly for annual lead resolution. (:pr:`332`) `Aaron Spring`_.
@@ -879,7 +849,6 @@ Internals/Minor Fixes
879849
- ``Comparison`` objects can now have aliases. (:pr:`310`) `Riley X. Brady`_.
880850

881851

882-
883852
climpred v1.2.1 (2020-01-07)
884853
============================
885854

@@ -1116,8 +1085,10 @@ Internals/Minor Fixes
11161085
- Add tests for :py:class:`.HindcastEnsemble` and
11171086
``PerfectModelEnsemble``. (:pr:`199`) `Riley X. Brady`_
11181087

1088+
11191089
climpred v1.0.0 (2019-07-03)
11201090
============================
1091+
11211092
``climpred`` v1.0.0 represents the first stable release of the package. It includes
11221093
:py:class:`.HindcastEnsemble` and ``PerfectModelEnsemble`` objects to
11231094
perform analysis with.
@@ -1217,11 +1188,12 @@ Internals/Minor Fixes
12171188
- Increase code coverage through more testing. (:pr:`167`) `Aaron Spring`_
12181189
- Consolidates checks and constants into modules. (:pr:`173`) `Andrew Huang`_
12191190

1191+
12201192
climpred v0.2 (2019-01-11)
12211193
==========================
12221194

1223-
Name changed to ``climpred``, developed enough for basic decadal prediction tasks on a
1224-
perfect-model ensemble and reference-based ensemble.
1195+
Name changed to ``climpred``, developed enough for basic decadal prediction tasks on a perfect-model ensemble and reference-based ensemble.
1196+
12251197

12261198
climpred v0.1 (2018-12-20)
12271199
==========================

0 commit comments

Comments
 (0)