blueetl.extract.simulations

Simulations extractor.

Classes

SimulationStatus(value[, names, module, ...])

Status of the loaded simulation.

Simulations(df, cached, filtered)

Simulations extractor class.

Exceptions

InconsistentSimulations

Error raised when the extracted simulations have some inconsistencies.
exception blueetl.extract.simulations.InconsistentSimulations

Bases: Exception

Error raised when the extracted simulations have some inconsistencies.

class blueetl.extract.simulations.SimulationStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Status of the loaded simulation.

class blueetl.extract.simulations.Simulations(df: DataFrame, cached: bool, filtered: bool)

Bases: BaseExtractor

Simulations extractor class.

Initialize the extractor.

Parameters:

  • df – Pandas DataFrame containing the extracted data.

  • cached – True if the data have been extracted from the cache, False otherwise.

  • filtered – True if the data have been filtered using a custom query, False otherwise.

classmethod from_config(config: SimulationCampaign, query: dict | None = None) → Simulations

Extract simulations from the given simulation campaign.

classmethod from_pandas(df: DataFrame, query: dict | None = None, cached: bool = True) → Simulations

Extract simulations from a dataframe containing valid simulation ids and circuit ids.

to_pandas() → DataFrame

Dump simulations to a dataframe that can be serialized and stored.