blueetl.adapters.interfaces.simulation

Interfaces for Simulation.

Classes

PopulationReportInterface()	PopulationReport Interface.
PopulationSpikesReportInterface()	PopulationSpikesReport Interface.
SimulationInterface(simulation)	Simulation Interface.

class blueetl.adapters.interfaces.simulation.PopulationReportInterface

Bases: ABC

PopulationReport Interface.

abstract get(group=None, t_start=None, t_stop=None, t_step=None) → DataFrame

Return the report for the specified group and interval.

class blueetl.adapters.interfaces.simulation.PopulationSpikesReportInterface

Bases: ABC

PopulationSpikesReport Interface.

abstract get(group=None, t_start=None, t_stop=None) → Series

Return the spikes report for the specified group and interval.

class blueetl.adapters.interfaces.simulation.SimulationInterface(simulation: SimulationT)

Bases: Generic[SimulationT], CachedPropertyMixIn, ABC

Simulation Interface.

Init the simulation interface with the specified simulation.

abstract property circuit: CircuitInterface

Return the circuit used for the simulation.

property instance: SimulationT

Return the wrapped instance.

abstract is_complete() → bool

Return True if the simulation is complete, False otherwise.

abstract property reports: Mapping[str, Mapping[str | None, PopulationReportInterface]]

name -> population -> report.

Type:

Return the reports as a dict

abstract property spikes: Mapping[str | None, PopulationSpikesReportInterface]

population -> report.

Type:

Return the spikes report as a dict