From 43135d71b911cd6e8b2e9c847ef1ed819d09dd76 Mon Sep 17 00:00:00 2001 From: Francesc Alted Date: Wed, 4 Dec 2024 13:43:26 +0100 Subject: [PATCH] Redirected the format docs --- README.rst | 13 ++++--------- README_B2ND_FORMAT.rst | 4 ++-- README_B2ND_METALAYER.rst | 2 +- 3 files changed, 7 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index 3b9f402f..c35b776b 100644 --- a/README.rst +++ b/README.rst @@ -41,7 +41,7 @@ See a 3 minutes `introductory video to Blosc2 `_ (or b2nd for short), allowing to create *and* read n-dimensional datasets in an extremely efficient way thanks to a n-dim 2-level partitioning, that allows to slice and dice arbitrary large and compressed data in a more fine-grained way: +One of the latest and more exciting additions in C-Blosc2 is the `Blosc2 NDim layer `_ (or B2ND for short), allowing to create *and* read n-dimensional datasets in an extremely efficient way thanks to a n-dim 2-level partitioning, that allows to slice and dice arbitrary large and compressed data in a more fine-grained way: .. image:: https://github.com/Blosc/c-blosc2/blob/main/images/b2nd-2level-parts.png?raw=true :width: 75% @@ -67,7 +67,7 @@ New features in C-Blosc2 * **64-bit containers:** the first-class container in C-Blosc2 is the `super-chunk` or, for brevity, `schunk`, that is made by smaller chunks which are essentially C-Blosc1 32-bit containers. The super-chunk can be backed or not by another container which is called a `frame` (see later). -* **NDim containers (b2nd):** allow to store n-dimensional data that can efficiently read datasets in slices that can be n-dimensional too. To achieve this, a n-dimensional 2-level partitioning has been implemented. This capabilities were formerly part of `Caterva `_, and now it is included in C-Blosc2 for convenience. Caterva is now deprecated. +* **NDim containers (B2ND):** allow to store n-dimensional data that can efficiently read datasets in slices that can be n-dimensional too. To achieve this, a n-dimensional 2-level partitioning has been implemented. This capabilities were formerly part of `Caterva `_, and now it is included in C-Blosc2 for convenience. Caterva is now deprecated. * **More filters:** besides `shuffle` and `bitshuffle` already present in C-Blosc1, C-Blosc2 already implements: @@ -123,14 +123,9 @@ C-Blosc2 API and format have been frozen, and that means that there is guarantee Open format =========== -The Blosc2 format is open and documented in the next documents: +The Blosc2 format is open and `fully documented `_. -* [The chunk; the basic building block](https://github.com/Blosc/c-blosc2/blob/main/README_CHUNK_FORMAT.rst) -* [The cframe; this is made of different chunks in contiguous storage](https://github.com/Blosc/c-blosc2/blob/main/README_CFRAME_FORMAT.rst) -* [The sframe; a variation of the cframe for sparse storage](https://github.com/Blosc/c-blosc2/blob/main/README_SFRAME_FORMAT.rst) -* [The b2nd metalayer; info for the n-dimensional data container](https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_METALAYER.rst) - -All these documents take less than 1000 lines of text, so they should be easy to read and understand. In our opinion, this is very important for the long-term success of the library, as it allows for third-party implementations of the format, and also for the users to understand what is going on under the hood. +The format specs are defined in less than 1000 lines of text, so they should be easy to read and understand. In our opinion, this is very important for the long-term success of the library, as it allows for third-party implementations of the format, and also for the users to understand what is going on under the hood. Python wrapper diff --git a/README_B2ND_FORMAT.rst b/README_B2ND_FORMAT.rst index 31d5b168..cb113b1d 100644 --- a/README_B2ND_FORMAT.rst +++ b/README_B2ND_FORMAT.rst @@ -1,7 +1,7 @@ -b2nd Format +B2ND Format =========== -The b2nd format is meant for storing multidimensional datasets defined by a shape and a data type. +The B2ND format is meant for storing multidimensional datasets defined by a shape and a data type. Both the shape and the data type follow the NumPy conventions. It is just a `B2ND metalayer `_ diff --git a/README_B2ND_METALAYER.rst b/README_B2ND_METALAYER.rst index 0d9024a3..215dc16c 100644 --- a/README_B2ND_METALAYER.rst +++ b/README_B2ND_METALAYER.rst @@ -1,4 +1,4 @@ -b2nd Metalayer Format +B2ND Metalayer Format ===================== This is a `metalayer `_ on top of a Blosc2 CFrame that is meant