blueetl.adapters.interfaces.circuit

Interfaces for Circuit.

Classes

CircuitInterface(circuit)	Circuit Interface.
NodePopulationInterface()	NodePopulation Interface.

class blueetl.adapters.interfaces.circuit.CircuitInterface(circuit: CircuitT)

Bases: Generic[CircuitT], CachedPropertyMixIn, ABC

Circuit Interface.

Init the circuit interface with the specified circuit.

abstract checksum() → str

Return a checksum of the relevant keys in the circuit configuration.

property instance: CircuitT

Return the wrapped instance.

abstract property node_sets: NodeSetsInterface

Returns the NodeSets used by the circuit.

abstract property node_sets_file: Path | None

Returns the NodeSets file used by the circuit.

abstract property nodes: Mapping[str | None, NodePopulationInterface]

population -> nodes.

Type:

Return the nodes as a dict

class blueetl.adapters.interfaces.circuit.NodePopulationInterface

Bases: ABC

NodePopulation Interface.

abstract get(group, properties) → DataFrame

Return a DataFrame of nodes.

abstract ids(group) → ndarray

Return an array of node ids.