Skip to main content

Running and stopping experiment profiles

Experiment profiles let you automate repeatable routines across your Pioreactor cluster. The UI is the fastest way to launch, monitor, and stop those routines.

Start a profile from the UI​

  1. Open the Profiles tab. In the sidebar, choose Profiles under the current experiment.

    Profiles tab highlighted in the sidebar

  2. Pick the profile to run. Use the dropdown to select the YAML profile you want to execute.

    Profile dropdown highlighted in the Available profiles section

  3. Start the profile. Click Run profile to launch it immediately.

    Run profile button highlighted

Dry-run mode

Open the button's chevron menu to choose Dry-run profile. Dry-run executes the schedule without touching hardware; it emits the planned actions so you can confirm timing or sequencing before running the real thing.

You can run multiple profiles—even multiple copies of the same profile—at the same time.

Monitor and stop running profiles​

Once started, profiles appear in Profiles Running with a link back to their definition and elapsed time.

Profiles Running table highlighted with an active profile

When you need to stop a profile early, use the Stop button in that table. Confirming the dialog terminates all actions the profile started and prevents any queued steps from running.

Stop button highlighted in the Profiles Running table

Confirm the prompt to finish shutting the profile down.

Stop profile confirmation dialog with the Stop Profile button highlighted

Run profiles from the CLI​

You can also launch profiles from the leader's terminal:

pio run experiment_profile execute </path/to/experiment_profile/.yaml> <experiment_name>

For example:

pio run experiment_profile execute /home/pioreactor/.pioreactor/experiment_profiles/chemostat_in_out_2.yaml 'level tests'

Stop all running profiles from the CLI with:

pio kill --job-name experiment_profile

Or target a specific profile by its job ID:

pio kill --job-id <job-id>