caterva2.Dataset

class caterva2.Dataset(name, root, urlbase, auth_cookie=None)

A dataset is a Blosc2 container in a file.

This is not intended to be instantiated directly, but accessed via a Root instance instead.

Parameters:

• name (str) – The name of the dataset.

• root (str) – The name of the root.

• urlbase (str) – The base of URLs of the subscriber to query. Default is caterva2.sub_urlbase_default.

• auth_cookie (str) – An optional cookie to authorize requests via HTTP.

Examples

>>> import caterva2 as cat2
>>> ds = cat2.Dataset('ds-1d.b2nd', 'example', 'https://demo.caterva2.net')
>>> ds.name
'ds-1d.b2nd'
>>> ds[1:10]
array([1, 2, 3, 4, 5, 6, 7, 8, 9])

Attributes:

vlmeta

A mapping of metalayer names to their respective values.

Used to access variable-length metalayers (i.e. user attributes) for a file.

>>> import caterva2 as cat2
>>> root = cat2.Root('example', 'https://demo.caterva2.net')
>>> file = root['ds-sc-attr.b2nd']
>>> file.vlmeta
{'a': 1, 'b': 'foo', 'c': 123.456}

Methods

copy(dst)	Copy a file to a new location.
download([localpath])	Download a file to storage.
fetch([slice_])	Fetch a slice of a dataset.
get_download_url()	Get the download URL for a file.
move(dst)	Move a file to a new location.
remove()	Remove a file from a remote repository.

__init__(name, root, urlbase, auth_cookie=None)

Methods

__init__(name, root, urlbase[, auth_cookie])
copy(dst)	Copy a file to a new location.
download([localpath])	Download a file to storage.
fetch([slice_])	Fetch a slice of a dataset.
get_download_url()	Get the download URL for a file.
move(dst)	Move a file to a new location.
remove()	Remove a file from a remote repository.

Attributes

vlmeta

A mapping of metalayer names to their respective values.