Skip to content

Commit c394a04

Browse files
committed
Getting ready for release 3.0.0b1
1 parent 92327da commit c394a04

File tree

2 files changed

+52
-20
lines changed

2 files changed

+52
-20
lines changed

ANNOUNCE.rst

+34-14
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,16 @@ filters, user-defined functions and broadcasting (still in beta). See this
1111
Also, we have added support for memory mapping in `SChunk` and `NDArray` instances.
1212
This allows to map super-chunks stored in disk and access them as if they were in memory.
1313

14-
Last, but not least, we have added support for NumPy 2.0.0. This means that our wheels
15-
are built against this version of NumPy, so you will need to use NumPy 1.23.0 or later.
14+
Last, but not least, we are using NumPy 2.x as the default for testing procedures and builds.
15+
This means that our wheels are built against this version of NumPy, so you will need to use
16+
NumPy 1.23.0 or later.
17+
18+
We are in the process of releasing 3.0.0 soon, so we would appreciate your feedback
19+
on this beta release. We are providing binary wheels that you can install with:
20+
21+
```
22+
pip install blosc2==3.0.0b1
23+
```
1624

1725
For more info, you can have a look at the release notes in:
1826

@@ -25,18 +33,30 @@ https://www.blosc.org/python-blosc2/python-blosc2.html
2533
What is it?
2634
-----------
2735

28-
Python-Blosc2 is a Python package that wraps C-Blosc2, the newest version of
29-
the Blosc compressor. Currently Python-Blosc2 already reproduces the API of
30-
Python-Blosc (https://github.com/Blosc/python-blosc), so the former can be
31-
used as a drop-in replacement for the later. However, there are a few
32-
exceptions for full compatibility:
33-
https://github.com/Blosc/python-blosc2/blob/main/RELEASE_NOTES.md#changes-from-python-blosc-to-python-blosc2
34-
35-
Python-Blosc2 comes with NDArray support, which is a new Python class that
36-
allows to create multi-dimensional arrays of compressed data. NDArray
37-
follows the same (or very similar) API as NumPy arrays, so it can be used
38-
as a drop-in replacement. See the documentation for more details:
39-
https://www.blosc.org/python-blosc2/reference/ndarray_api.html
36+
`C-Blosc2 <https://github.com/Blosc/c-blosc2>`_ is the new major version of
37+
`C-Blosc <https://github.com/Blosc/c-blosc>`_, and is backward compatible with
38+
both the C-Blosc1 API and its in-memory format. Python-Blosc2 is a Python package
39+
that wraps C-Blosc2, the newest version of the Blosc compressor.
40+
41+
Starting with version 3.0.0, Python-Blosc2 is including a powerful computing engine
42+
that can operate on compressed data that can be either in-memory, on-disk or on the
43+
network. This engine also supports advanced features like reductions, filters,
44+
user-defined functions and broadcasting (still in beta).
45+
46+
You can read our tutorial on how to peform advanced computations at:
47+
48+
* https://github.com/Blosc/python-blosc2/blob/main/doc/getting_started/tutorials/03.lazyarray-expressions.ipynb
49+
* https://github.com/Blosc/python-blosc2/blob/main/doc/getting_started/tutorials/03.lazyarray-udf.ipynb
50+
51+
In addition, Python-Blosc2 aims to leverage the full C-Blosc2 functionality to support
52+
super-chunks (`SChunk <https://www.blosc.org/python-blosc2/reference/schunk_api.html>`_),
53+
multi-dimensional arrays
54+
(`NDArray <https://www.blosc.org/python-blosc2/reference/ndarray_api.html>`_),
55+
metadata, serialization and other bells and whistles introduced in C-Blosc2.
56+
57+
**Note:** Blosc2 is meant to be backward compatible with Blosc(1) data.
58+
That means that it can read data generated with Blosc, but the opposite
59+
is not true (i.e. there is no *forward* compatibility).
4060

4161
Sources repository
4262
------------------

README.rst

+18-6
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,15 @@ both the C-Blosc1 API and its in-memory format. Python-Blosc2 is a Python packag
3232
that wraps C-Blosc2, the newest version of the Blosc compressor.
3333

3434
Starting with version 3.0.0, Python-Blosc2 is including a powerful computing engine
35-
that can operate on compressed data that can be either in-memory, on-disk or on the network.
36-
This engine also supports advanced features like reductions, filters, user-defined functions
37-
and broadcasting (still in beta). You can read our tutorial on how to use this new feature at:
38-
https://github.com/Blosc/python-blosc2/blob/main/doc/getting_started/tutorials/03.lazyarray-expressions.ipynb and
39-
https://github.com/Blosc/python-blosc2/blob/main/doc/getting_started/tutorials/03.lazyarray-udf.ipynb
35+
that can operate on compressed data that can be either in-memory, on-disk or on the
36+
network. This engine also supports advanced features like reductions, filters,
37+
user-defined functions and broadcasting (still in beta).
38+
39+
You can read our tutorial on how to peform advanced computations at:
40+
41+
* https://github.com/Blosc/python-blosc2/blob/main/doc/getting_started/tutorials/03.lazyarray-expressions.ipynb
42+
* https://github.com/Blosc/python-blosc2/blob/main/doc/getting_started/tutorials/03.lazyarray-udf.ipynb
43+
4044

4145
In addition, Python-Blosc2 aims to leverage the full C-Blosc2 functionality to support
4246
super-chunks (`SChunk <https://www.blosc.org/python-blosc2/reference/schunk_api.html>`_),
@@ -145,13 +149,21 @@ https://github.com/Blosc/python-blosc2/blob/main/bench/ndarray/lazyarray-expr.ip
145149
Installing
146150
==========
147151

148-
Blosc is now offering Python wheels for the main OS (Win, Mac and Linux) and platforms.
152+
Blosc2 is now offering Python wheels for the main OS (Win, Mac and Linux) and platforms.
149153
You can install binary packages from PyPi using ``pip``:
150154

151155
.. code-block:: console
152156
153157
pip install blosc2
154158
159+
We are in the process of releasing 3.0.0, and we will be releasing wheels for different
160+
beta versions. For example, to install the first beta version, you can do:
161+
162+
.. code-block:: console
163+
164+
pip install blosc2==3.0.0b1
165+
166+
155167
Documentation
156168
=============
157169

0 commit comments

Comments
 (0)