Bamboostbamboost.core.simulation.dict
Classes
Parameters
Parameters
(self, simulation)Arguments:
- simulation:
_Simulation[bamboost.core.hdf5.file._MT]
Attributes:
- _dict:
SimulationParameterT - _obj:
h5py.h5py.Group
Bases
AttrsDict10
Parameters.__setitem__
(self, key, value) -> NoneArguments:
- key:
str - value:
typing.Any
Parameters.__getitem__
(self, key) -> AnyGet a parameter. Can use nested access with dot notation.
Arguments:
- key:
str
Parameters.read
(self) -> dictRead 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) -> NoneUpdate the parameters dictionary. This method pushes the update to the HDF5 file, and the SQL database.
Arguments:
- update_dict:
typing.Mappingnew parameters
Parameters._ipython_key_completions_
(self) -> Generator[str, None, None]Links
Links
(self, simulation) -> NoneArguments:
- simulation:
_Simulation[bamboost.core.hdf5.file._MT]
Bases
AttrsDict16
AttrsDict.__new__()AttrsDict.mutableAttrsDict._pathAttrsDict._dictAttrsDict.read()AttrsDict._ipython_key_completions_()AttrsDict.__iter__()AttrsDict.__len__()AttrsDict.__repr__()AttrsDict.__str__()AttrsDict._repr_pretty_()AttrsDict._objAttrsDict.__setitem__()AttrsDict.setAttrsDict.__delitem__()AttrsDict.update()
Links.__getitem__
(self, key) -> '_Simulation'Arguments:
- key:
str
Metadata
Metadata
(self, simulation) -> NoneThe metadata of a simulation are the attributes of the root group.
Arguments:
- simulation:
_Simulation[bamboost.core.hdf5.file._MT]
Attributes:
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
Bases
AttrsDict15
Metadata.__setitem__
(self, key, value) -> NoneArguments:
- key:
str - value:
typing.Any
Metadata.update
(self, update_dict) -> None