pyphi.sweep#

pyphi.sweep(substrates, *, states, subsets='full', formalisms=None, compute='sia', parallel=None, progress=None, seed=None)[source]#

Run a computation across the cartesian product of axes into a tidy table.

Parameters:

substrates (Any) – A single substrate, a sequence of substrates (labeled by position), or a mapping of label to substrate.
states (Any) – A state tuple, an iterable of states, or "all". Explicit states apply to every substrate; "all" enumerates per substrate.
subsets (Any) – "full" (whole system), "all" (non-empty powerset), or an iterable of node-index tuples. Explicit subsets apply to every substrate; "full" and "all" are resolved per substrate.
formalisms (Any) – Leave unset to compute IIT under the active configuration, honored exactly as pyphi.analyze() honors it (no preset is applied, so runtime customizations survive). To reproduce published results, pass an iterable of version names ("IIT_4_0_2023", "IIT_3_0", or "IIT_4_0_2026" for the current version), each of which applies its complete preset. See Reproduce results from earlier versions of IIT.
compute (Any) – "sia" (default), "ces", or a callable taking a System.
parallel (bool or None, optional) – None follows config.infrastructure.parallel; True or False forces.
progress (bool or None, optional) – None follows config; True or False forces.
seed (int or None, optional) – Stamped into each result’s provenance (a bookkeeping label).

Returns:

SweepResult – The tidy long-format table, the aligned raw result objects, and the list of cells skipped because their state is dynamically unreachable.

Return type:

SweepResult

Notes

Cells are skipped (rather than raising) only when an axis is enumerated via "all"; when every axis is given explicitly, an uncomputable cell raises.