`models.subsystem`¶

Subsystem-level objects.

class pyphi.models.subsystem.SystemStateSpecification(cause: pyphi.models.mechanism.StateSpecification, effect: pyphi.models.mechanism.StateSpecification)¶

cause: StateSpecification¶

effect: StateSpecification¶

to_json()¶

pyphi.models.subsystem.defaultdict_set()¶

class pyphi.models.subsystem.CauseEffectStructure(concepts=(), subsystem=None, resolved_congruence=False)¶

A collection of concepts.

order_by()¶

Return a list of values to compare for ordering.

The first value in the list has the greatest priority; if the first objects are equal the second object is compared, etc.

to_json()¶

property flat¶: An iterator over causes and effects.

flatten()¶: Return this as a FlatCauseEffectStructure.

unflatten()¶: Return self.

sum_phi()¶

property phis¶: The \(\varphi\) values of each concept.

property mechanisms¶: The mechanism of each concept.

purviews(direction)¶: Return the purview of each concept in the given direction.

property labeled_mechanisms¶: The labeled mechanism of each concept.

purview_inclusion_of_intersection(min_order, max_order)¶

purview_inclusion(max_order=None)¶

Return a mapping:

{order: {frozenset[Unit]: {distinctions whose cause/effect purview: union includes those Units}}}

resolve_congruence(system_state: SystemStateSpecification)¶: Filter out incongruent distinctions.

mechanism_multiplicities()¶

state_multiplicities()¶

property resolved_congruence¶

pyphi.models.subsystem.flatten_distinctions(distinctions)¶

class pyphi.models.subsystem.FlatCauseEffectStructure(concepts=(), subsystem=None)¶

A collection of maximally-irreducible components in either causal direction.

property purviews¶: The purview of each component.

property specified_purviews¶: The set of unique purviews specified by this CES.

specifiers(purview)¶: The components that specify the given purview.

maximum_specifier(purview)¶: Return the components that maximally specify the given purview.

maximum_specifiers()¶: Return a mapping from each purview to its maximum specifier.

property flat¶: An iterator over causes and effects.

flatten()¶: Return this as a FlatCauseEffectStructure.

unflatten()¶: Return self.

class pyphi.models.subsystem.SystemIrreducibilityAnalysis(phi=None, ces=None, partitioned_ces=None, subsystem=None, cut_subsystem=None)¶

An analysis of system irreducibility (\(\Phi\)).

Contains the \(\Phi\) value of the Subsystem, the cause-effect structure, and all the intermediate results obtained in the course of computing them.

These can be compared with the built-in Python comparison operators (<, >, etc.). First, \(\Phi\) values are compared. Then, if these are equal up to PRECISION, the one with the larger subsystem is greater.

phi¶

The \(\Phi\) value for the subsystem when taken against this analysis, i.e. the difference between the cause-effect structure and the partitioned cause-effect structure for this analysis.

Type:: float

ces¶

The cause-effect structure of the whole subsystem.

Type:: CauseEffectStructure

partitioned_ces¶

The cause-effect structure when the subsystem is cut.

Type:: CauseEffectStructure

subsystem¶

The subsystem this analysis was calculated for.

Type:: Subsystem

cut_subsystem¶

The subsystem with the minimal cut applied.

Type:: Subsystem

time¶

The number of seconds it took to calculate.

Type:: float

print(ces=True)¶: Print this SystemIrreducibilityAnalysis, optionally without cause-effect structures.

property cut¶: The unidirectional cut that makes the least difference to the subsystem.

property network¶: The network the subsystem belongs to.

unorderable_unless_eq = ['network']¶

__bool__()¶: A SystemIrreducibilityAnalysis is True if it has \(\Phi > 0\).

to_json()¶: Return a JSON-serializable representation.

classmethod from_json(dct)¶

models.subsystem¶

`models.subsystem`¶