siibra.retrieval.datasets

Metadata connection to EBRAINS datasets.

Module Contents

Classes

EbrainsBaseDataset	Helper class that provides a standard way to create an ABC using
EbrainsDataset	Ebrains dataset v1 connection
EbrainsDatasetUrl	A simple typed namespace. At runtime it is equivalent to a plain dict.
EbrainsV3Dataset	Helper class that provides a standard way to create an ABC using
EbrainsV3DatasetVersion	Helper class that provides a standard way to create an ABC using
GenericDataset

Attributes

EbrainsDatasetEmbargoStatus
EbrainsDatasetPerson

class siibra.retrieval.datasets.EbrainsBaseDataset

Helper class that provides a standard way to create an ABC using inheritance.

property LICENSE: str

abstract property contributors: List[EbrainsDatasetPerson]

abstract property custodians: List[EbrainsDatasetPerson]

abstract property description: str

abstract property ebrains_page: str

abstract property id: str

abstract property name: str

abstract property urls: List[EbrainsDatasetUrl]

__eq__(o: object) → bool

Return self==value.

__hash__()

Return hash(self).

match(spec: str | EbrainsBaseDataset) → bool

Checks if the given specification describes this dataset.

Parameters:

• (str (spec) – specification to be matched.

• EbrainsBaseDataset) – specification to be matched.

Return type:

bool

class siibra.retrieval.datasets.EbrainsDataset(id, name=None, embargo_status: List[EbrainsDatasetEmbargoStatus] = None, *, cached_data=None)

Ebrains dataset v1 connection

property contributors: List[EbrainsDatasetPerson]

property custodians: EbrainsDatasetPerson

property description: str

property ebrains_page

property id: str

property name: str

property urls: List[EbrainsDatasetUrl]

class siibra.retrieval.datasets.EbrainsDatasetUrl

A simple typed namespace. At runtime it is equivalent to a plain dict.

TypedDict creates a dictionary type that expects all of its instances to have a certain set of keys, where each key is associated with a value of a consistent type. This expectation is not checked at runtime but is only enforced by type checkers. Usage:

class Point2D(TypedDict):
    x: int
    y: int
    label: str

a: Point2D = {'x': 1, 'y': 2, 'label': 'good'}  # OK
b: Point2D = {'z': 3, 'label': 'bad'}           # Fails type check

assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')

The type info can be accessed via Point2D.__annotations__. TypedDict supports two additional equivalent forms:

Point2D = TypedDict('Point2D', x=int, y=int, label=str)
Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})

By default, all keys must be present in a TypedDict. It is possible to override this by specifying totality. Usage:

class point2D(TypedDict, total=False):
    x: int
    y: int

This means that a point2D TypedDict can have any of the keys omitted.A type checker is only expected to support a literal False or True as the value of the total argument. True is the default, and makes all items defined in the class body be required.

The class syntax is only supported in Python 3.6+, while two other syntax forms work for Python 2.7 and 3.2+

url: str

class siibra.retrieval.datasets.EbrainsV3Dataset(id, *, cached_data=None)

Helper class that provides a standard way to create an ABC using inheritance.

property contributors

property custodians: EbrainsDatasetPerson

property description: str

property ebrains_page: str

property id: str

property name: str

property urls: List[EbrainsDatasetUrl]

property version_ids: List[str]

class siibra.retrieval.datasets.EbrainsV3DatasetVersion(id, *, cached_data=None)

Helper class that provides a standard way to create an ABC using inheritance.

property contributors: List[EbrainsDatasetPerson]

property custodians: EbrainsDatasetPerson

property description: str

property ebrains_page: str

property id: str

property is_version_of

property name: str

property urls: List[EbrainsDatasetUrl]

property version_changelog

property version_identifier

class siibra.retrieval.datasets.GenericDataset(name: str = None, contributors: List[str] = None, url: str = None, description: str = None, license: str = None)

property LICENSE: str

property contributors

property description: str

property id: str

property name: str

property urls: List[EbrainsDatasetUrl]

__eq__(o: object) → bool

Return self==value.

__hash__()

Return hash(self).

siibra.retrieval.datasets.EbrainsDatasetEmbargoStatus

siibra.retrieval.datasets.EbrainsDatasetPerson