Skip to content

Commit

Permalink
Diagram for the CFrame
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescAlted committed Dec 4, 2024
1 parent 0560b61 commit 20cfd0d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README_FORMAT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,19 @@ and that allows for fast random access to the compressed data. The format is des
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.

Here there is a list of the different parts of the format, from the highest level to the lowest:
See a diagram of a Contiguous Frame (aka CFrame), the most important part of the Blosc2 format below:

- `b2nd format <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_FORMAT.rst>`_
- `b2nd metalayer <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_METALAYER.rst>`_
- `sframe format <https://github.com/Blosc/c-blosc2/blob/main/README_SFRAME_FORMAT.rst>`_
- `cframe format <https://github.com/Blosc/c-blosc2/blob/main/README_CFRAME_FORMAT.rst>`_
- `chunk format <https://github.com/Blosc/c-blosc2/blob/main/README_CHUNK_FORMAT.rst>`_
.. image:: blosc2-cframe.png
:alt: Blosc2 Format Diagram

And here the recommended extension file names for the different parts of the format:
And here, the list of the different parts of the format, from the highest level to the lowest:

- `B2ND format <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_FORMAT.rst>`_
- `B2ND metalayer <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_METALAYER.rst>`_
- `SFrame format <https://github.com/Blosc/c-blosc2/blob/main/README_SFRAME_FORMAT.rst>`_
- `CFrame format <https://github.com/Blosc/c-blosc2/blob/main/README_CFRAME_FORMAT.rst>`_
- `Chunk format <https://github.com/Blosc/c-blosc2/blob/main/README_CHUNK_FORMAT.rst>`_

Finally, the recommended extension file names for the different parts of the format:

- `Blosc2 extension file names <https://github.com/Blosc/c-blosc2/blob/main/README_EXTENSION_FILENAMES.rst>`_
Binary file added blosc2-cframe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 20cfd0d

Please sign in to comment.