simdb.cli.manifest module

class simdb.cli.manifest.AliasValidator(version: int)

Bases: ManifestValidator

Validator for simulation alias.

validate(value)

class simdb.cli.manifest.DataObject(base_path: Path, uri: str)

Bases: object

Simulation data object, either a file, an IDS or an already registered object identifiable by the UUID.

PATH: file:///<PATH> IMAS: imas:<BACKEND>?path=<PATH>

class Type(value)

Bases: Enum

FILE = 3

IMAS = 4

UDA = 5

UNKNOWN = 1

UUID = 2

property name: str

type: Type = 1

uri: URI | None = None

class simdb.cli.manifest.DataObjectValidator(version: int, section_name: str)

Bases: ListValuesValidator

Validator for the manifest data objects (inputs or outputs).

validate(values: list | dict) → None

class simdb.cli.manifest.DescriptionValidator(version: int)

Bases: ManifestValidator

Validator for simulation description.

class simdb.cli.manifest.DictValuesValidator(version: int, section_name: str = NotImplemented, expected_keys: Iterable = NotImplemented, required_keys: Iterable = NotImplemented)

Bases: ManifestValidator

Class for the validation of dictionary items in the manifest.

expected_keys: Iterable

required_keys: Iterable

section_name: str

validate(values: list | dict) → None

class simdb.cli.manifest.InputsValidator(version)

Bases: DataObjectValidator

Validator for the manifest inputs list.

exception simdb.cli.manifest.InvalidAlias

Bases: InvalidManifest

Exception to throw when the alias specified in the manifest is invalid.

exception simdb.cli.manifest.InvalidManifest

Bases: Exception

Exception to throw when a manifest fails to validate.

class simdb.cli.manifest.ListValuesValidator(version: int, section_name: str = NotImplemented, expected_keys: Iterable = NotImplemented, required_keys: Iterable = NotImplemented)

Bases: ManifestValidator

Class for the validation of list items in the manifest.

expected_keys: Iterable

required_keys: Iterable

section_name: str

validate(values: list | dict) → None

class simdb.cli.manifest.Manifest

Bases: object

Class to handle reading, writing & validation of simulation manifest files.

property alias: str | None

classmethod from_template() → Manifest

Create an empty manifest from a template file.

Returns:

A new manifest object.

property inputs: Iterable[Source]

load(file_path: Path) → None

Load a manifest from the given file.

Parameters:

file_path – Path to the file read.

Returns:

None

property manifest_version: int

property metadata: Dict

property outputs: Iterable[Sink]

property responsible_name: str | None

save(out_file: TextIO) → None

Save the manifest to the given file.

Parameters:

out_file – The output text stream to write the manifest to.

Returns:

None

validate() → None

Validate the manifest object.

Returns:

None

property version: int

class simdb.cli.manifest.ManifestValidator(version: int)

Bases: object

Base class for validation of manifests.

validate(values: List | Dict) → None

version: int

class simdb.cli.manifest.MetaDataValidator(version: int)

Bases: ListValuesValidator

Validator for the manifest Metadata list.

forbidden_characters = (':', '=', '#')

validate(values: list | dict) → None

class simdb.cli.manifest.OutputsValidator(version)

Bases: DataObjectValidator

Validator for the manifest outputs list.

class simdb.cli.manifest.ResponsibleValidator(version: int)

Bases: ManifestValidator

Validator for simulation Responsible.

class simdb.cli.manifest.Sink(base_path: Path, uri: str)

Bases: DataObject

Simulation data outputs.

class simdb.cli.manifest.Source(base_path: Path, uri: str)

Bases: DataObject

Simulation data inputs.

class simdb.cli.manifest.VersionValidator(version: int)

Bases: ManifestValidator

Validator for manifest version.

validate(value)

class simdb.cli.manifest.WorkflowValidator(version: int)

Bases: DictValuesValidator

Validator for the manifest workflow dictionary.

simdb.cli.manifest.get_loader() → Type[SafeLoader]

simdb.cli.manifest.ndarray_constructor(loader: SafeLoader, node: MappingNode) → ndarray