caterva2.fetch#

caterva2.fetch(path, urlbase=None, slice_=None, auth_cookie=None)#

Retrieves a specified slice (or the entire content) of a dataset.

Parameters:

path¶ (str) – Path to the dataset.
urlbase¶ (str, optional) – Base URL to query. Defaults to caterva2.sub_urlbase_default.
slice_¶ (str, optional) – Slice of the dataset to retrieve. Fetches the entire dataset if not provided.
auth_cookie¶ (str, optional) – HTTP cookie for authorization.

Returns:

The requested slice of the dataset as a Numpy array.

Return type:

numpy.ndarray

Examples

>>> import caterva2 as cat2
>>> urlbase = 'https://demo.caterva2.net'
>>> cat2.subscribe('example', urlbase)
'Ok'
>>> cat2.fetch('example/ds-2d-fields.b2nd', urlbase, "0:2, 0:2")
array([[(0.0000000e+00, 1.       ), (5.0002502e-05, 1.00005  )],
       [(1.0000500e-02, 1.0100005), (1.0050503e-02, 1.0100505)]],
      dtype=[('a', '<f4'), ('b', '<f8')])