MetaData

class ase2sprkkr.asr.core.results.MetaData(**kwargs)[source]

Metadata object.

Examples

>>> metadata = MetaData(asr_name='asr.gs')
>>> metadata
asr_name=asr.gs
>>> metadata.code_versions = {'asr': '0.1.2'}
>>> metadata
asr_name=asr.gs
code_versions={'asr': '0.1.2'}
>>> metadata.set(resources={'time': 10}, params={'a': 1})
>>> metadata
asr_name=asr.gs
code_versions={'asr': '0.1.2'}
resources={'time': 10}
params={'a': 1}
>>> metadata.todict()
{'asr_name': 'asr.gs', 'code_versions': {'asr': '0.1.2'}, 'resources': {'time': 10}, 'params': {'a': 1}}

Class hierarchy

Inheritance diagram of ase2sprkkr.asr.core.results.MetaData

Constructor

__init__(**kwargs)[source]

Initialize MetaData object.

accepted_keys = {'asr_name', 'code_versions', 'creates', 'params', 'requires', 'resources'}
set(**kwargs)[source]

Set metadata values.

validate()[source]

Assert integrity of metadata.

property asr_name

For example ‘asr.gs’.

property params

Return dict containing parameters.

property resources

Return resources.

property code_versions

Return code versions.

property creates

Return list of created files.

property requires

Return list of required files.

_set(key, value)[source]
_get(key)[source]
todict()[source]

Format metadata as dict.