pyrates

adapters.pyrates

PyRates backend adapter for SimulationExperiment.

This module handles all PyRates-specific logic for running simulations, converting between TVBO and PyRates data formats, and computing outputs.

Classes

Name Description
PyRatesAdapter Adapter for running SimulationExperiment via PyRates backend.

PyRatesAdapter

adapters.pyrates.PyRatesAdapter(experiment)

Adapter for running SimulationExperiment via PyRates backend.

Methods

Name Description
run Run simulation and explorations using PyRates backend.
run
adapters.pyrates.PyRatesAdapter.run(
    solver=None,
    inputs=None,
    outputs=None,
    matrix_edge_threshold=100,
    **kwargs,
)

Run simulation and explorations using PyRates backend.

Handles both integration and grid-search explorations in a single call, sharing YAML export / circuit load across both.

Parameters

solver : str, optional ODE solver: “euler”, “heun”, “scipy”. Defaults to mapped integration.method. inputs : dict, optional External inputs as {node/op/var: array} or will be auto-generated. outputs : list[str], optional Variables to monitor. If None, monitors all state variables. matrix_edge_threshold : int, optional For networks with N > threshold nodes, use add_edges_from_matrix instead of YAML edges for efficiency. Default is 100. **kwargs Additional kwargs passed to circuit.run() / grid_search().

Returns

ExperimentResult