Bamboostbamboost.index.uids
Classes
CollectionUID
UID of a collection. If no UID is provided, a new one is generated.
Note
The generated UID is guaranteed to be unique across MPI ranks by broadcasting the generated UUID from the root rank.
CollectionUID.__new__
(cls, uid=None, length=10)Arguments:
- cls
- uid:
str | None=None - length:
int=10
CollectionUID.generate_uid
(length) -> strArguments:
- length:
int
SimulationName
Name of a simulation. If no name is provided, a new one is generated.
Note
The generated name is guaranteed to be unique across MPI ranks by broadcasting the generated UUID from the root rank.
SimulationName.__new__
(cls, name=None, length=10)Arguments:
- cls
- name:
str | None=None - length:
int=10
SimulationName.generate_name
(length) -> strArguments:
- length:
int
SimulationUID
SimulationUID
(self) -> NoneUID of a simulation, consisting of the collection UID and the simulation name.
Use str(SimulationUID(...)) to get the string representation of the UID, which is in
the format <collection_uid>:<simulation_name>. The constructor can be called with
either the string representation or the collection UID and simulation name as separate
arguments.
Attributes:
- collection_uid:
CollectionUID - simulation_name:
SimulationName
SimulationUID.__str__
(self)SimulationUID.__eq__
(self, other)Arguments:
- other
SimulationUID.__new__
(cls, *args)Arguments:
- cls
- args=
()