Skip to content

Commit 70d601b

Browse files
Merge pull request #246 from omaech/new-frontpage
Updating the Python-Blosc2 documentation section
2 parents 491f3db + 35d289b commit 70d601b

File tree

2 files changed

+63
-6
lines changed

2 files changed

+63
-6
lines changed

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
.. include:: python-blosc2.rst
1+
.. include:: python-blosc2.rst

doc/python-blosc2.rst

Lines changed: 62 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,68 @@
1-
Python-Blosc2 documentation
2-
============================
1+
.. raw:: html
32

4-
Python-Blosc2 is a Python package for handling large NDim and plain datasets stored in a compressed state either in-memory or on-disk.
5-
Under the hood, it uses [C-Blosc2](https://www.blosc.org/c-blosc2/c-blosc2.html), a fast, compressed and persistent data store library
6-
for C.
3+
<h1 class="text-center">Python-Blosc2: Compress Better, Compute Bigger</h1>
4+
5+
.. panels::
6+
:card: intro-card text-center no-border
7+
:column: col-lg-4 col-md-6 col-sm-12 mb-4
8+
:container: + gap-3
9+
10+
**Excellent compression capabilities**
11+
12+
13+
Blosc2 uses advanced codecs and filters for efficient compression, reducing storage
14+
space while maintaining high performance.
15+
16+
---
17+
18+
**Binary data optimization**
19+
20+
21+
Blosc2 is designed to optimize binary data (integers, floats, bools), enhancing
22+
compression, and accelerating processing, making it ideal for high-performance numerical
23+
applications.
24+
25+
---
26+
27+
**Flexible storage**
28+
29+
30+
Blosc2 offers storage in memory, disk, or network, adapting to your needs and
31+
facilitating integration into various systems.
32+
33+
---
34+
35+
**N-dimensional, compressed arrays**
736

837

38+
Blosc2 supports NDArray objects for the efficient storage and manipulation of
39+
multidimensional data, making it ideal for complex data sets.
40+
41+
---
42+
43+
**Two-level partitions**
44+
45+
46+
Blosc2 employs two-level partitions to optimize CPU cache, enhancing data access and
47+
performance in computational tasks.
48+
49+
---
50+
51+
**Optimized compute engine**
52+
53+
54+
Blosc2 accelerates complex mathematical operations and data processing with an
55+
optimized compute engine.
56+
57+
.. raw:: html
58+
59+
<h1 class="text-center">Documentation</h1>
60+
961
.. panels::
1062
:card: + intro-card text-center
1163
:column: col-lg-6 col-md-12 col-sm-12 col-xs-12 d-flex
64+
:container: + gap-3
65+
1266

1367
---
1468

@@ -36,6 +90,7 @@ for C.
3690

3791
+++
3892

93+
3994
.. link-button:: reference/index
4095
:type: ref
4196
:text: To the reference guide
@@ -73,6 +128,7 @@ for C.
73128
:classes: btn-info
74129

75130

131+
76132
.. toctree::
77133
:maxdepth: 1
78134
:hidden:
@@ -81,3 +137,4 @@ for C.
81137
API Reference <reference/index>
82138
Development <development/index>
83139
Release Notes <release_notes/index>
140+

0 commit comments

Comments
 (0)