Experiment Control

Run experiments and analyses from the command line.

class vivarium.core.control.Control(out_dir: Optional[str] = None, experiments: Optional[Dict[str, Any]] = None, composers: Optional[Dict[str, Any]] = None, plots: Optional[Dict[str, Any]] = None, workflows: Optional[Dict[str, Any]] = None, args: Optional[Sequence[str]] = None)[source]

Bases: object

Control experiments from the command line

Load experiments, plots, and workflows in this Control class, and trigger them from the command line

parse_args(args: Optional[Sequence[str]] = None)argparse.Namespace[source]
run_experiment(experiment_config: Union[str, dict])Dict[Union[Tuple, str], Any][source]
run_one_plot(plot_config: Union[str, dict], data: Dict[Union[Tuple, str], Any], out_dir: Optional[str] = None)None[source]
run_plots(plot_ids: Union[list, str], data: Dict[Union[Tuple, str], Any], out_dir: Optional[str] = None)None[source]
run_workflow(workflow_id: str)None[source]
vivarium.core.control.is_float(element: Any)bool[source]
vivarium.core.control.make_dir(out_dir: str = 'out')None[source]
vivarium.core.control.run_library_cli(library: dict, args: Optional[list] = None)None[source]

Run experiments from the command line

Parameters

library (dict) – maps experiment id to experiment function

vivarium.core.control.toy_control(args: Optional[Sequence[str]] = None)vivarium.core.control.Control[source]

a toy example of control

To run: > python vivarium/core/control.py -w 1

vivarium.core.control.toy_plot(data: Dict[Union[Tuple, str], Any], config: Optional[Dict] = None, out_dir: Optional[str] = 'out')None[source]