Bamboost
bamboostcoresimulationdict

bamboost.core.simulation.dict

Source: https://gitlab.com/cmbm-ethz/bamboost/-/blob/main/bamboost/core/simulation/dict.py

Classes

Parameters

Parameters(self, simulation)
Arguments:
Attributes:
  • _simulation:_Simulation=bamboost.core.simulation.dict.Parameters(simulation)
  • _obj:h5py.h5py.Group
Parameters.__setitem__(self, key, value) -> None
Arguments:
  • key:str
  • value:typing.Any
Parameters.__getitem__(self, key) -> Any

Get a parameter. Can use nested access with dot notation.

Arguments:
  • key:str
Parameters.read(self) -> dict

Read the parameters from the HDF5 file.

In addition to the attributes from the group, this method also reads in all datasets in the group.

Parameters.update(self, update_dict) -> None

Update the parameters dictionary. This method pushes the update to the HDF5 file, and the SQL database.

Arguments:
  • update_dict:typing.Mapping

    new parameters

Parameters._ipython_key_completions_(self) -> Generator[str, None, None]
Links(self, simulation) -> None
Arguments:
Links.__getitem__(self, key) -> '_Simulation'
Arguments:
  • key:str

Metadata

Metadata(self, simulation) -> None

The metadata of a simulation are the attributes of the root group.

Arguments:
Attributes:
  • _simulation:_Simulation=bamboost.core.simulation.dict.Metadata(simulation)

Special metadata that is handled by bamboost

status: Status of the simulation created_at: Creation date of the simulation description: Optional description of the simulation

Metadata.__setitem__(self, key, value) -> None
Arguments:
  • key:str
  • value:typing.Any
Metadata.update(self, update_dict) -> None

Update the metadata dictionary. This method pushes the update to the HDF5 file, and the SQL database.

Arguments:
  • update_dict:

    new metadata

base

Simulation management module for bamboost.

groups

Next Page

On this page

Classes
Parameters
__setitem__
__getitem__
read
update
_ipython_key_completions_
Links
__getitem__
Metadata
__setitem__
update