Skip to content

doc: update release notes for 3.0.0.alpha #1959

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 12, 2024
Merged

doc: update release notes for 3.0.0.alpha #1959

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
239 changes: 222 additions & 17 deletions docs/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,24 @@ Release notes
# to document your changes. On releases it will be
# re-indented so that it does not show up in the notes.

.. _unreleased(v3):
.. note::
Zarr-Python 2.18.* is expected be the final release in the 2.* series. Work on Zarr-Python 3.0 is underway.
See `GH1777 <https://github.com/zarr-developers/zarr-python/issues/1777>`_ for more details on the upcoming
3.0 release.

Unreleased (v3)
---------------
.. release_3.0.0.alpha:

3.0.0.alpha
-----------

.. warning::
Zarr-Python 3.0.0.alpha is a pre-release of the upcoming 3.0 release. This release is not feature complete or
expected to be ready for production applications.

.. note::
The complete release notes for 3.0 have not been added to this document yet. See the
`3.0.0.alpha <https://github.com/zarr-developers/zarr-python/releases/tag/v3.0.0.alpha>`_ release on GitHub
for a record of changes included in this release.

Enhancements
~~~~~~~~~~~~
Expand All @@ -31,10 +45,160 @@ Maintenance
The dependency relationship is now reversed: the test suite imports this class from ``zarr-python``.
By :user:`Davis Bennett <d-v-b>` :issue:`1601`.

.. _unreleased:

Unreleased (v2)
---------------
.. _release_2.18.2:

2.18.2
------

Enhancements
~~~~~~~~~~~~

* Add Zstd codec to old V3 code path.
By :user:`Ryan Abernathey <rabernat>`

.. _release_2.18.1:

2.18.1
------

Maintenance
~~~~~~~~~~~
* Fix a regression when getting or setting a single value from arrays with size-1 chunks.
By :user:`Deepak Cherian <dcherian>` :issue:`1874`

.. _release_2.18.0:

2.18.0
------

Enhancements
~~~~~~~~~~~~
* Performance improvement for reading and writing chunks if any of the dimensions is size 1.
By :user:`Deepak Cherian <dcherian>` :issue:`1730`.

Maintenance
~~~~~~~~~~~
* Enable ruff/bugbear rules (B) and fix issues.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`1702`.

* Minor updates to use `np.inf` instead of `np.PINF` / `np.NINF` in preparation for NumPy 2.0.0 release.
By :user:`Joe Hamman <jhamman>` :issue:`1842`.

Deprecations
~~~~~~~~~~~~

* Deprecate experimental v3 support by issuing a `FutureWarning`.
Also updated docs to warn about using the experimental v3 version.
By :user:`Joe Hamman <jhamman>` :issue:`1802` and :issue:`1807`.

* Deprecate the following stores: :class:`zarr.storage.DBMStore`, :class:`zarr.storage.LMDBStore`,
:class:`zarr.storage.SQLiteStore`, :class:`zarr.storage.MongoDBStore`, :class:`zarr.storage.RedisStore`,
and :class:`zarr.storage.ABSStore`. These stores are slated to be removed from Zarr-Python in version 3.0.
By :user:`Joe Hamman <jhamman>` :issue:`1801`.

.. _release_2.17.2:

2.17.2
------

Enhancements
~~~~~~~~~~~~

* [v3] Dramatically reduce number of ``__contains__`` requests in favor of optimistically calling `__getitem__`
and handling any error that may arise.
By :user:`Deepak Cherian <dcherian>` :issue:`1741`.

* [v3] Reuse the downloaded array metadata when creating an ``Array``.
By :user:`Deepak Cherian <dcherian>` :issue:`1734`.

* Optimize ``Array.info`` so that it calls `getsize` only once.
By :user:`Deepak Cherian <dcherian>` :issue:`1733`.

* Override IPython ``_repr_*_`` methods to avoid expensive lookups against object stores.
By :user:`Deepak Cherian <dcherian>` :issue:`1716`.

* FSStore now raises rather than return bad data.
By :user:`Martin Durant <martindurant>` and :user:`Ian Carroll <itcarroll>` :issue:`1604`.

* Avoid redundant ``__contains__``.
By :user:`Deepak Cherian <dcherian>` :issue:`1739`.

Docs
~~~~

* Fix link to GCSMap in ``tutorial.rst``.
By :user:`Daniel Jahn <dahnj>` :issue:`1689`.

* Endorse `SPEC0000 <https://scientific-python.org/specs/spec-0000/>`_ and state version support policy in ``installation.rst``.
By :user:`Sanket Verma <msankeys963>` :issue:`1665`.

* Migrate v1 and v2 specification to `Zarr-Specs <https://zarr-specs.readthedocs.io/en/latest/specs.html>`_.
By :user:`Sanket Verma <msankeys963>` :issue:`1582`.

Maintenance
~~~~~~~~~~~

* Add CI test environment for Python 3.12
By :user:`Joe Hamman <jhamman>` :issue:`1719`.

* Bump minimum supported NumPy version to 1.23 (per spec 0000)
By :user:`Joe Hamman <jhamman>` :issue:`1719`.

* Minor fixes: Using ``is`` instead of ``type`` and removing unnecessary ``None``.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`1737`.

* Fix tests failure related to Pytest 8.
By :user:`David Stansby <dstansby>` :issue:`1714`.

.. _release_2.17.1:

2.17.1
------

Enhancements
~~~~~~~~~~~~

* Change occurrences of % and format() to f-strings.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`1423`.

* Proper argument for numpy.reshape.
By :user:`Dimitri Papadopoulos Orfanos <DmitriPapadopoulos>` :issue:`1425`.

* Add typing to dimension separator arguments.
By :user:`David Stansby <dstansby>` :issue:`1620`.

Docs
~~~~

* ZIP related tweaks.
By :user:`Davis Bennett <d-v-b>` :issue:`1641`.

Maintenance
~~~~~~~~~~~

* Update config.yml with Zulip.
By :user:`Josh Moore <joshmoore>`.

* Replace Gitter with the new Zulip Chat link.
By :user:`Sanket Verma <msankeys963>` :issue:`1685`.

* Fix RTD build.
By :user:`Sanket Verma <msankeys963>` :issue:`1694`.

.. _release_2.17.0:

2.17.0
------

Enhancements
~~~~~~~~~~~~

* Added type hints to ``zarr.creation.create()``.
By :user:`David Stansby <dstansby>` :issue:`1536`.

* Pyodide support: Don't require fasteners on Emscripten.
By :user:`Hood Chatham <hoodmane>` :issue:`1663`.

Docs
~~~~
Expand All @@ -57,10 +221,30 @@ Docs
* Minor tweak to advanced indexing tutorial examples.
By :user:`Ross Barnowski <rossbar>` :issue:`1550`.

* Automatically document array members using sphinx-automodapi.
By :user:`David Stansby <dstansby>` :issue:`1547`.

* Add a markdown file documenting the current and former core-developer team.
By :user:`Joe Hamman <jhamman>` :issue:`1628`.

* Add Norman Rzepka to core-dev team.
By :user:`Joe Hamman <jhamman>` :issue:`1630`.

* Added section about accessing ZIP archives on s3.
By :user:`Jeff Peck <jeffpeck10x>` :issue:`1613`, :issue:`1615`, and :user:`Davis Bennett <d-v-b>` :issue:`1641`.

* Add V3 roadmap and design document.
By :user:`Joe Hamman <jhamman>` :issue:`1583`.

Maintenance
~~~~~~~~~~~

* Drop Python 3.8 and NumPy 1.20
By :user:`Josh Moore <joshmoore>`; :issue:`1557`.

* Cache result of ``FSStore._fsspec_installed()``.
By :user:`Janick Martinez Esturo <ph03>` :issue:`1581`.

* Extend copyright notice to 2023.
By :user:`Jack Kelly <JackKelly>` :issue:`1528`.

Expand All @@ -79,6 +263,27 @@ Maintenance
* Remove ``sphinx-rtd-theme`` dependency from ``pyproject.toml``.
By :user:`Sanket Verma <MSanKeys963>` :issue:`1563`.

* Remove ``CODE_OF_CONDUCT.md`` file from the Zarr-Python repository.
By :user:`Sanket Verma <MSanKeys963>` :issue:`1572`.

* Bump version of black in pre-commit.
By :user:`David Stansby <dtstansby>` :issue:`1559`.

* Use list comprehension where applicable.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`1555`.

* Use format specification mini-language to format string.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`1558`.

* Single startswith() call instead of multiple ones.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`1556`.

* Move codespell options around.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`1196`.

* Remove unused mypy ignore comments.
By :user:`David Stansby <dtstansby>` :issue:`1602`.

.. _release_2.16.1:

2.16.1
Expand Down Expand Up @@ -120,10 +325,10 @@ Maintenance
By :user:`Davis Bennett <d-v-b>` :issue:`1462`.

* Style the codebase with ``ruff`` and ``black``.
By :user:`Davis Bennett` <d-v-b> :issue:`1459`
By :user:`Davis Bennett <d-v-b>` :issue:`1459`

* Ensure that chunks is tuple of ints upon array creation.
By :user:`Philipp Hanslovsky` <hanslovsky> :issue:`1461`
By :user:`Philipp Hanslovsky <hanslovsky>` :issue:`1461`

.. _release_2.15.0:

Expand Down Expand Up @@ -511,7 +716,7 @@ Maintenance
By :user:`Saransh Chopra <Saransh-cpp>` :issue:`1079`.

* Remove option to return None from _ensure_store.
By :user:`Greggory Lee <grlee77>` :issue:`1068`.
By :user:`Gregory Lee <grlee77>` :issue:`1068`.

* Fix a typo of "integers".
By :user:`Richard Scott <RichardScottOZ>` :issue:`1056`.
Expand All @@ -529,7 +734,7 @@ Enhancements
Since the format is not yet finalized, the classes and functions are not
automatically imported into the regular `zarr` name space. Setting the
`ZARR_V3_EXPERIMENTAL_API` environment variable will activate them.
By :user:`Greggory Lee <grlee77>`; :issue:`898`, :issue:`1006`, and :issue:`1007`
By :user:`Gregory Lee <grlee77>`; :issue:`898`, :issue:`1006`, and :issue:`1007`
as well as by :user:`Josh Moore <joshmoore>` :issue:`1032`.

* **Create FSStore from an existing fsspec filesystem**. If you have created
Expand Down Expand Up @@ -651,7 +856,7 @@ Enhancements
higher-level array creation and convenience functions still accept plain
Python dicts or other mutable mappings for the ``store`` argument, but will
internally convert these to a ``KVStore``.
By :user:`Greggory Lee <grlee77>`; :issue:`839`, :issue:`789`, and :issue:`950`.
By :user:`Gregory Lee <grlee77>`; :issue:`839`, :issue:`789`, and :issue:`950`.

* Allow to assign array ``fill_values`` and update metadata accordingly.
By :user:`Ryan Abernathey <rabernat>`, :issue:`662`.
Expand Down Expand Up @@ -798,7 +1003,7 @@ Bug fixes
~~~~~~~~~

* Fix FSStore.listdir behavior for nested directories.
By :user:`Greggory Lee <grlee77>`; :issue:`802`.
By :user:`Gregory Lee <grlee77>`; :issue:`802`.

.. _release_2.9.4:

Expand Down Expand Up @@ -882,7 +1087,7 @@ Bug fixes
By :user:`Josh Moore <joshmoore>`; :issue:`781`.

* avoid NumPy 1.21.0 due to https://github.com/numpy/numpy/issues/19325
By :user:`Greggory Lee <grlee77>`; :issue:`791`.
By :user:`Gregory Lee <grlee77>`; :issue:`791`.

Maintenance
~~~~~~~~~~~
Expand All @@ -894,7 +1099,7 @@ Maintenance
By :user:`Elliott Sales de Andrade <QuLogic>`; :issue:`799`.

* TST: add missing assert in test_hexdigest.
By :user:`Greggory Lee <grlee77>`; :issue:`801`.
By :user:`Gregory Lee <grlee77>`; :issue:`801`.

.. _release_2.8.3:

Expand Down Expand Up @@ -1538,11 +1743,11 @@ Bug fixes
Documentation
~~~~~~~~~~~~~

* Some changes have been made to the :ref:`spec_v2` document to clarify
* Some changes have been made to the Zarr Specification v2 document to clarify
ambiguities and add some missing information. These changes do not break compatibility
with any of the material as previously implemented, and so the changes have been made
in-place in the document without incrementing the document version number. See the
section on :ref:`spec_v2_changes` in the specification document for more information.
section on changes in the specification document for more information.
* A new :ref:`tutorial_indexing` section has been added to the tutorial.
* A new :ref:`tutorial_strings` section has been added to the tutorial
(:issue:`135`, :issue:`175`).
Expand Down Expand Up @@ -1812,4 +2017,4 @@ See `v0.4.0 release notes on GitHub
See `v0.3.0 release notes on GitHub
<https://github.com/zarr-developers/zarr-python/releases/tag/v0.3.0>`_.

.. _Numcodecs: https://numcodecs.readthedocs.io/
.. _Numcodecs: https://numcodecs.readthedocs.io/