sbmlsim.experiment.runner

Runner for SimulationExperiments.

The ExperimentRunner is used to execute simulation experiments. This includes - loading of datasets - loading of models - running tasks (simulation on models) - creating outputs

Module Contents

Classes

ExperimentRunner

Class for running simulation experiments.

Attributes

logger

sbmlsim.experiment.runner.logger[source]
class sbmlsim.experiment.runner.ExperimentRunner(experiment_classes, base_path, data_path, simulator=None, ureg=None, **kwargs)[source]

Bases: object

Class for running simulation experiments.

Parameters
set_simulator(self, simulator)[source]

Set simulator on the runner and experiments.

Parameters

simulator (sbmlsim.simulator.SimulatorSerial) –

Return type

None

initialize(self, experiment_classes, **kwargs)[source]

Initialize ExperimentRunner.

Initialization is required in addition to construction to allow serialization of information for parallelization.

run_experiments(self, output_path, show_figures=False, save_results=False, figure_formats=None, reduced_selections=True)[source]

Run the experiments.

Parameters

  • output_path (pathlib.Path) –

  • show_figures (bool) –

  • save_results (bool) –

  • figure_formats (List[str]) –

  • reduced_selections (bool) –

Return type

List[sbmlsim.experiment.ExperimentResult]