Skip to content

Commit 050d068

Browse files
committed
Updated Python-Blosc2 frontpage for more updated contents
1 parent f09c628 commit 050d068

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

doc/python-blosc2.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@
6868
.. raw:: html
6969

7070
<div style="text-align: center;">
71-
<i class="fas fa-th" style="font-size: 2em; color: #007acc; margin-bottom: 10px;"></i>
72-
<h3 style="margin-top: 10px; margin-bottom: 15px;">Sparse Data Mastery</h3>
71+
<i class="fas fa-sitemap" style="font-size: 2em; color: #007acc; margin-bottom: 10px;"></i>
72+
<h3 style="margin-top: 10px; margin-bottom: 15px;">Hierarchical Structures</h3>
7373
</div>
7474

75-
Efficiently store and manipulate sparse data with `compact sparse constructs <https://www.blosc.org/docs/Exploring-MilkyWay-SciPy2023.pdf>`_ for optimized `performance <https://www.blosc.org/docs/Exploring-MilkyWay-SciPy2023-paper.pdf>`_.
75+
Efficiently store data hierachically with the `TreeStore class <https://www.blosc.org/python-blosc2/reference/tree_store.html#blosc2.TreeStore>`_ for convenience and optimized `performance <https://www.blosc.org/posts/new-treestore-blosc2/>`_.
7676

7777
.. grid-item-card::
7878
:class-card: intro-card text-center no-border
@@ -84,7 +84,7 @@
8484
<h3 style="margin-top: 10px; margin-bottom: 15px;">Flexible Storage</h3>
8585
</div>
8686

87-
Access data from anywhere: read/write in `memory or disk <https://github.com/Blosc/python-blosc2/blob/main/doc/getting_started/tutorials/01.ndarray-basics.ipynb>`_, stream from `the network <https://www.blosc.org/python-blosc2/reference/c2array.html>`_, or use `memory-mapped files <https://www.blosc.org/python-blosc2/reference/storage.html#blosc2.Storage.params.mmap_mode>`_ for high-performance I/O.
87+
Access data from anywhere: read/write in `memory or disk <https://www.blosc.org/docs/Exploring-MilkyWay-SciPy2023-paper.pdf>`_, stream from `the network <https://www.blosc.org/python-blosc2/reference/c2array.html>`_, or use `memory-mapped files <https://www.blosc.org/python-blosc2/reference/storage.html#blosc2.Storage.params.mmap_mode>`_ for high-performance I/O.
8888

8989
.. grid-item-card::
9090
:class-card: intro-card text-center no-border

src/blosc2/c2array.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ def c2context(
4545
A parameter not specified or set to ``None`` will inherit the value from the
4646
previous context manager, defaulting to an environment variable (see
4747
below) if supported by that parameter. Parameters set to an empty string
48-
will not to be used in requests (with no default either).
48+
will not be used in requests (without a default either).
4949
5050
If the subscriber requires authorization for requests, you can either
5151
provide an `auth_token` (which you should have obtained previously from the
5252
subscriber), or both `username` and `password` to obtain the token by
5353
logging in to the subscriber. The token will be reused until it is explicitly
54-
reset or requested again in a subsequent context manager invocation.
54+
reset or requested again in a later context manager invocation.
5555
5656
Please note that this manager is reentrant but not safe for concurrent use.
5757
@@ -190,6 +190,10 @@ class C2Array(blosc2.Operand):
190190
def __init__(self, path: str, /, urlbase: str | None = None, auth_token: str | None = None):
191191
"""Create an instance of a remote NDArray.
192192
193+
Remote NDArrays can be accessed via HTTP from a Caterva2 server
194+
(e.g., https://cat2.cloud). More information about Caterva2 at:
195+
https://ironarray.io/caterva2.
196+
193197
Parameters
194198
----------
195199
path: str

src/blosc2/tree_store.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,12 @@ def __len__(self):
8080

8181
class TreeStore(DictStore):
8282
"""
83-
A hierarchical tree-based storage container for compressed data using Blosc2.
83+
A hierarchical tree-based storage container for Blosc2 data.
8484
85-
Extends DictStore with strict hierarchical key validation and tree traversal
86-
capabilities. Keys must follow a hierarchical structure using '/' as separator
87-
and always start with '/'. If user passes a key that doesn't start with '/',
88-
it will be automatically added.
85+
Extends :class:`blosc2.DictStore` with strict hierarchical key validation
86+
and tree traversal capabilities. Keys must follow a hierarchical structure
87+
using '/' as separator and always start with '/'. If user passes a key
88+
that doesn't start with '/', it will be automatically added.
8989
9090
It supports the same arguments as :class:`blosc2.DictStore`.
9191

0 commit comments

Comments
 (0)