diff --git a/README_B2ND_FORMAT.rst b/README_B2ND_FORMAT.rst index d25a9534..693fac2b 100644 --- a/README_B2ND_FORMAT.rst +++ b/README_B2ND_FORMAT.rst @@ -1,4 +1,4 @@ -b2nd format +b2nd Format =========== The b2nd format is just a `b2nd metalayer `_ diff --git a/README_B2ND_METALAYER.rst b/README_B2ND_METALAYER.rst index e9a957e0..ed22404f 100644 --- a/README_B2ND_METALAYER.rst +++ b/README_B2ND_METALAYER.rst @@ -1,5 +1,5 @@ -b2nd metalayer -============== +b2nd Metalayer Format +===================== This is a `metalayer `_ on top of a Blosc2 container that is meant for storing multidimensional information. diff --git a/README_CHUNK_FORMAT.rst b/README_CHUNK_FORMAT.rst index a9b61aa5..4e2ef686 100644 --- a/README_CHUNK_FORMAT.rst +++ b/README_CHUNK_FORMAT.rst @@ -1,5 +1,5 @@ -Blosc Chunk Format -================== +Blosc/Blosc2 Chunk Format +========================= A regular chunk is composed of a header and a blocks section:: diff --git a/README_EXTENSION_FILENAMES.rst b/README_EXTENSION_FILENAMES.rst index 89eac541..dd608a25 100644 --- a/README_EXTENSION_FILENAMES.rst +++ b/README_EXTENSION_FILENAMES.rst @@ -1,8 +1,8 @@ -Extensions for Blosc2 filenames +Extensions for Blosc2 Filenames =============================== -Blosc2 has different file extensions for different purposes. Here is a list of the currently supported ones: +Blosc2 has some recommendations for different file extensions for different purposes. Here is a list of the currently supported ones: - `.b2frame` (but also `.b2f` or `.b2`) (Blosc2 frame): this is the main extension for storing `Blosc2 contiguous frames `_. -- `.b2nd` (Blosc2 n-dimensional): this is just a contiguous frame file with `a metalayer for storing n-dimensional information `_ like shape, chunkshape, blockshape and dtype. +- `.b2nd` (Blosc2 N-Dimensional): this is just a contiguous frame file with `a metalayer for storing n-dimensional information `_ like shape, chunkshape, blockshape and dtype. diff --git a/README_FORMAT.rst b/README_FORMAT.rst index 955bd8b4..a2b52bdd 100644 --- a/README_FORMAT.rst +++ b/README_FORMAT.rst @@ -1,4 +1,4 @@ -Blosc2 format +Blosc2 Format ============= The Blosc2 format is a specification for storing compressed data in a way that is simple to read and parse, @@ -13,3 +13,7 @@ Here there is a list of the different parts of the format, from the highest leve - `sframe format `_ - `cframe format `_ - `chunk format `_ + +And here the recommended extension file names for the different parts of the format: + +- `Blosc2 extension file names `_ diff --git a/doc/format/extension_filenames.rst b/doc/format/extension_filenames.rst new file mode 100644 index 00000000..fc611e66 --- /dev/null +++ b/doc/format/extension_filenames.rst @@ -0,0 +1 @@ +.. include:: ../../README_EXTENSION_FILENAMES.rst diff --git a/doc/format/index.rst b/doc/format/index.rst index d6d5099e..aa2f1850 100644 --- a/doc/format/index.rst +++ b/doc/format/index.rst @@ -11,6 +11,7 @@ Blosc2 Format sframe_format cframe_format chunk_format + extension_filenames The Blosc2 format is a specification for storing compressed data in a way that is simple to read and parse, and that allows for fast random access to the compressed data. The format is designed to be used with the Blosc2 library, but it is not tied to it, and can be used independently. Emphasis has been put on simplicity and robustness, so that the format can be used in a wide range of applications.