From 5279bd15708e21ea582e56e4f27fc3e9663a8509 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Fri, 10 Jan 2025 00:16:00 -0700 Subject: [PATCH] dev whats-new (#9936) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * dev whats-new * silence warning * [skip-ci] add rich * [skip-ci] add :okwarning: for ipython blocks which use to_zarr in user-guide/io.rst * [skip-ci] add :okwarning: for ipython blocks which use open_zarr in user-guide/io.rst * [skip-ci] remove :okwarning: for python code block --------- Co-authored-by: Kai Mühlbauer --- ci/requirements/doc.yml | 1 + doc/internals/zarr-encoding-spec.rst | 1 + doc/user-guide/io.rst | 7 +++++++ doc/whats-new.rst | 27 +++++++++++++++++++++++++++ 4 files changed, 36 insertions(+) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index fc1234b787a..2d02b2339d2 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -31,6 +31,7 @@ dependencies: - pre-commit - pyarrow - pyproj + - rich # for Zarr tree() - scipy!=1.10.0 - seaborn - setuptools diff --git a/doc/internals/zarr-encoding-spec.rst b/doc/internals/zarr-encoding-spec.rst index 7f468b8b0db..958dad166e1 100644 --- a/doc/internals/zarr-encoding-spec.rst +++ b/doc/internals/zarr-encoding-spec.rst @@ -53,6 +53,7 @@ As a concrete example, here we write a tutorial dataset to Zarr and then re-open it directly with Zarr: .. ipython:: python + :okwarning: import os import xarray as xr diff --git a/doc/user-guide/io.rst b/doc/user-guide/io.rst index 8561d37ed40..60ab1720ecf 100644 --- a/doc/user-guide/io.rst +++ b/doc/user-guide/io.rst @@ -661,6 +661,7 @@ To write to a local directory, we pass a path to a directory: ! rm -rf path/to/directory.zarr .. ipython:: python + :okwarning: ds = xr.Dataset( {"foo": (("x", "y"), np.random.rand(4, 5))}, @@ -697,6 +698,7 @@ To read back a zarr dataset that has been created this way, we use the :py:func:`open_zarr` method: .. ipython:: python + :okwarning: ds_zarr = xr.open_zarr("path/to/directory.zarr") ds_zarr @@ -771,6 +773,7 @@ to Zarr: ! rm -rf path/to/directory.zarr .. ipython:: python + :okwarning: import dask.array @@ -823,6 +826,7 @@ For example: ! rm -rf foo.zarr .. ipython:: python + :okwarning: import zarr from numcodecs.blosc import Blosc @@ -873,6 +877,7 @@ order, e.g., for time-stepping a simulation: ! rm -rf path/to/directory.zarr .. ipython:: python + :okwarning: ds1 = xr.Dataset( {"foo": (("x", "y", "t"), np.random.rand(4, 5, 2))}, @@ -940,6 +945,7 @@ space on disk or in memory, yet when writing to disk the default zarr behavior i split them into chunks: .. ipython:: python + :okwarning: ds.to_zarr("path/to/directory.zarr", mode="w") ! ls -R path/to/directory.zarr @@ -950,6 +956,7 @@ storage provider. To disable this chunking, we can specify a chunk size equal to length of each dimension by using the shorthand chunk size ``-1``: .. ipython:: python + :okwarning: ds.to_zarr( "path/to/directory.zarr", diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 5c960c13287..a19345b4ef6 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -14,6 +14,33 @@ What's New np.random.seed(123456) +.. _whats-new.2025.01.2: + +v2025.01.2 (unreleased) +----------------------- + +New Features +~~~~~~~~~~~~ + + +Breaking changes +~~~~~~~~~~~~~~~~ + + +Deprecations +~~~~~~~~~~~~ + + +Bug fixes +~~~~~~~~~ + + +Documentation +~~~~~~~~~~~~~ + + +Internal Changes +~~~~~~~~~~~~~~~~ .. _whats-new.2025.01.1: