Getting ready for release 3.3.0

Author: FrancescAlted

ANNOUNCE.rst

@@ -1,16 +1,12 @@
-Announcing Python-Blosc2 3.2.1
+Announcing Python-Blosc2 3.3.0
 ==============================
 
-Here, all array containers in Blosc2 implement the ``__array_interface__``
-protocol to expose the data in the array.  This allows for better
-interoperability with other libraries like NumPy, CuPy, etc.  Now, the range
-of functions spans to most of NumPy functions, including reductions.
+We are introducing a new blosc2.transpose() function for natively transposing
+2D NDArray instances and a fast path for NDArray.slice() that delivers up to
+40x speedup when slices align with underlying chunks. Documentation has also
+been improved with several edits throughout.
 
-See examples at: https://github.com/Blosc/python-blosc2/blob/main/examples/ndarray/jit-numpy-funcs.py
-See benchmarks at: https://github.com/Blosc/python-blosc2/blob/main/bench/ndarray/jit-numpy-funcs.py
-
-We have also improved the performance of constructors like ``blosc2.linspace()``
-or ``blosc2.arange()`` by a factor of up to 3x for large arrays.
+See benchmarks at: https://github.com/Blosc/python-blosc2/blob/main/bench/ndarray/aligned_chunks.py
 
 You can think of Python-Blosc2 3.x as an extension of NumPy/numexpr that:
 

RELEASE_NOTES.md

@@ -1,8 +1,22 @@
 # Release notes
 
-## Changes from 3.2.1 to 3.2.2
+## Changes from 3.2.1 to 3.3.0
 
-XXX version-specific blurb XXX
+* New `blosc2.transpose()` function for transposing 2D NDArray instances
+  natively. See PR #375 and docs at
+  https://www.blosc.org/python-blosc2/reference/autofiles/operations_with_arrays/blosc2.transpose.html#blosc2.transpose
+  Thanks to Ricardo Sales Piquer (@ricardosp4) for the implementation.
+
+* New fast path for `NDArray.slice()` for getting slices that are aligned with
+  underlying chunks. This is a common operation when working with NDArray
+  instances, and now it is up to 40x faster in our benchmarks (see PR #380).
+
+* Returned `NDArray` object in `NDarray.slice()` now defaults to original
+  codec/clevel/filters. The previous behavior was to use the default
+  codec/clevel/filters.  See PR #378.  Thanks to Luke Shaw (@lshaw8317).
+
+* Several English edits in the documentation.  Thanks to Luke Shaw (@lshaw8317)
+  for his help in this area.
 
 ## Changes from 3.2.0 to 3.2.1
 

pyproject.toml

@@ -40,7 +40,7 @@ dependencies = [
     "py-cpuinfo; platform_machine != 'wasm32'",
     "requests",
 ]
-version = "3.2.2.dev0"
+version = "3.3.0"
 
 
 [project.optional-dependencies]

src/blosc2/ndarray.py

@@ -1913,6 +1913,11 @@ def slice(self, key: int | slice | Sequence[slice], **kwargs: Any) -> NDArray:
         (4, 10)
         >>> print(type(c))
         <class 'blosc2.ndarray.NDArray'>
+
+        Notes
+        -----
+        There is a fast path for slices that are aligned with underlying chunks.
+        Aligned means that the slices are made entirely with complete chunks.
         """
         if "cparams" not in kwargs:
             kwargs["cparams"] = {
@@ -3877,6 +3882,8 @@ def transpose(x, **kwargs: Any) -> NDArray:
     """
     Returns a Blosc2 NDArray with axes transposed.
 
+    Only 2D arrays are supported for now.  Other dimensions raise an error.
+
     Parameters
     ----------
     x: :ref:`NDArray`

src/blosc2/version.py

@@ -1 +1 @@
-__version__ = "3.2.2.dev0"
+__version__ = "3.3.0"