pyphi.macro.system.MacroSystem

class pyphi.macro.system.MacroSystem(substrate, state, node_indices=None, partition=None, external_indices=None, background_conditioning=None, background_state=None, units=(), micro_substrate=None, micro_history=(), macro_cause_marginal=None)

Bases: System

A system of macro units, consumed by the pipeline like a System.

Construct with from_micro(). The inherited substrate field holds the synthetic macro substrate; the micro universe lives in micro_substrate.

Parameters:

• substrate (Substrate)

• state (State)

• node_indices (NodeIndices)

• partition (DirectedBipartition)

• external_indices (tuple[int, ...])

• background_conditioning (str | None)

• background_state (tuple[int, ...] | None)

• units (tuple[MacroUnit, ...])

• micro_substrate (Substrate | None)

• micro_history (tuple[tuple[int, ...], ...])

• macro_cause_marginal (FactoredTPM | None)

classmethod from_micro(substrate, units, micro_history, node_labels=None)

Build a MacroSystem from a micro substrate and macro units.

Parameters:

• substrate (Substrate) – The binary micro universe.

• units (sequence of MacroUnit) – The system’s macro units (Eq. 19 must hold).

• micro_history (sequence of universe states) – Universe micro states, oldest first, of length max(tau_J). A bare state is accepted when every unit has micro grain 1.

• node_labels (optional) – Labels for the macro units.

Return type:

MacroSystem

classmethod from_substrate(*args, **kwargs)

Construct a System from a substrate, state, and optional node subset.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

MacroSystem

property cause_marginal: FactoredTPM

The construction’s cause TPM (Eqs. 26-40, cause weighting).

property proper_cause_marginal: FactoredTPM

there is no macro background.

Type:

Identical to cause_marginal