Or add to an experiment

continuation

classes.continuation

Continuation

Runtime wrapper around the auto-generated Continuation dataclass.

Provides from_file / from_string factory methods so that a continuation specification can be loaded from YAML just like Dynamics.

Usage

from tvbo import Continuation cont = Continuation.from_db(“Generic2dOscillator-bifurcation”) print(cont.name) eq_in_I

exp = SimulationExperiment() exp.continuations[cont.name] = cont

Classes

Name Description
Continuation Runtime continuation specification with factory constructors.

Continuation

classes.continuation.Continuation(name='continuation', **kwargs)

Runtime continuation specification with factory constructors.

Inherits all schema-defined fields (free_parameters, ds, max_steps, branches, etc.) from the generated datamodel and adds convenience factory methods.

Methods

Name Description
from_datamodel Create from an auto-generated datamodel instance.
from_db Load a Continuation by name from the tvbo database.
from_file Load a Continuation from a YAML file.
from_string Create a Continuation from a YAML string.
list_db List available continuations in the tvbo database.
from_datamodel
classes.continuation.Continuation.from_datamodel(cont_meta)

Create from an auto-generated datamodel instance.

from_db
classes.continuation.Continuation.from_db(name)

Load a Continuation by name from the tvbo database.

from_file
classes.continuation.Continuation.from_file(path)

Load a Continuation from a YAML file.

The file can be either: 1. A standalone Continuation YAML (root keys are Continuation fields). 2. A SimulationExperiment YAML that contains a continuations section — in which case the first continuation entry is returned.

Parameters

path : str or PathLike Path to the YAML file.

Returns

Continuation The loaded continuation specification.

from_string
classes.continuation.Continuation.from_string(yaml_string)

Create a Continuation from a YAML string.

Parameters

yaml_string : str YAML-formatted string defining the continuation.

Returns

Continuation

list_db
classes.continuation.Continuation.list_db()

List available continuations in the tvbo database.