siibra.retrieval.datasets

Metadata connection to EBRAINS datasets.

Attributes

`EbrainsDatasetEmbargoStatus`
`EbrainsDatasetPerson`

Classes

`EbrainsBaseDataset`	Helper class that provides a standard way to create an ABC using
`EbrainsDataset`	Ebrains dataset v1 connection
`EbrainsDatasetUrl`	dict() -> new empty dictionary
`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`

Module Contents

class siibra.retrieval.datasets.EbrainsBaseDataset

Inheritance diagram of siibra.retrieval.datasets.EbrainsBaseDataset

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

__eq__(o: object) → bool

__hash__()

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

property LICENSE: str

property contributors: List[EbrainsDatasetPerson]

Abstractmethod:

property custodians: List[EbrainsDatasetPerson]

Abstractmethod:

property description: str

Abstractmethod:

property ebrains_page: str

Abstractmethod:

property id: str

Abstractmethod:

property name: str

Abstractmethod:

property urls: List[EbrainsDatasetUrl]

Abstractmethod:

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

Inheritance diagram of siibra.retrieval.datasets.EbrainsDataset

Ebrains dataset v1 connection

property contributors: List[EbrainsDatasetPerson]

property custodians: EbrainsDatasetPerson

property description: str

property ebrains_page

embargo_status = None

property id: str

property name: str

property urls: List[EbrainsDatasetUrl]

class siibra.retrieval.datasets.EbrainsDatasetUrl

Inheritance diagram of siibra.retrieval.datasets.EbrainsDatasetUrl

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

url: str

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

Inheritance diagram of siibra.retrieval.datasets.EbrainsV3Dataset

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)

Inheritance diagram of siibra.retrieval.datasets.EbrainsV3DatasetVersion

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)

__eq__(o: object) → bool

__hash__()

property LICENSE: str

property contributors

property description: str

property id: str

property name: str

property urls: List[EbrainsDatasetUrl]

siibra.retrieval.datasets.EbrainsDatasetEmbargoStatus

siibra.retrieval.datasets.EbrainsDatasetPerson