Skip to content

Commit db710e9

Browse files
experiment profiles
1 parent 706192d commit db710e9

File tree

6 files changed

+33
-14
lines changed

6 files changed

+33
-14
lines changed
236 KB
Loading
277 KB
Loading
237 KB
Loading
243 KB
Loading
237 KB
Loading

user-guide/03-Extending your Pioreactor/04-Experiment Profiles/03-start-stop-profiles.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,60 @@ title: Running and stopping experiment profiles
33
slug: /start-stop-experiment-profiles
44
---
55

6-
### Running an experiment profile
6+
Experiment profiles let you automate repeatable routines across your Pioreactor cluster. The UI is the fastest way to launch, monitor, and stop those routines.
77

8-
Once you've created your profile to your satisfaction, you can run it from the UI's Profile page. Select your profile from the dropdown, and choose to run it. You can run multiple experiment profiles at once, including multiple instances of the same profile.
8+
## Start a profile from the UI
99

10-
The profile begins immediately, and you should see it running in the right-most box (refresh the page if you don't see it).
10+
1. **Open the Profiles tab.** In the sidebar, choose **Profiles** under the current experiment.
1111

12-
:::tip
13-
Alternatively, you can run a profile in "dry-run" mode, which doesn't perform any actions, just prints out what would occur instead.
12+
![Profiles tab highlighted in the sidebar](/img/user-guide/experiment-profiles/profiles-sidebar.png)
13+
14+
2. **Pick the profile to run.** Use the dropdown to select the YAML profile you want to execute.
15+
16+
![Profile dropdown highlighted in the Available profiles section](/img/user-guide/experiment-profiles/profile-dropdown.png)
17+
18+
3. **Start the profile.** Click **Run profile** to launch it immediately.
19+
20+
![Run profile button highlighted](/img/user-guide/experiment-profiles/profile-start-button.png)
21+
22+
:::tip Dry-run mode
23+
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.
1424
:::
1525

16-
You can also run profiles from the leader's command line. To run a profile, use:
26+
You can run multiple profiles—even multiple copies of the same profile—at the same time.
27+
28+
## Monitor and stop running profiles
29+
30+
Once started, profiles appear in **Profiles Running** with a link back to their definition and elapsed time.
31+
32+
![Profiles Running table highlighted with an active profile](/img/user-guide/experiment-profiles/profile-running.png)
33+
34+
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.
35+
36+
![Stop button highlighted in the Profiles Running table](/img/user-guide/experiment-profiles/profile-stop.png)
37+
38+
## Run profiles from the CLI
39+
40+
You can also launch profiles from the leader's terminal:
1741

1842
```bash
1943
pio run experiment_profile execute </path/to/experiment_profile/.yaml> <experiment_name>
2044
```
45+
2146
For example:
2247

2348
```bash
2449
pio run experiment_profile execute /home/pioreactor/.pioreactor/experiment_profiles/chemostat_in_out_2.yaml 'level tests'
2550
```
2651

27-
28-
### Stopping experiment profiles
29-
30-
From the same page, you can stop any running experiment profile. This will halt any jobs that were started by the profile, and stop executing any new actions in the queue.
31-
32-
From the command line, you can run:
52+
Stop all running profiles from the CLI with:
3353

3454
```bash
3555
pio kill --job-name experiment_profiles
3656
```
3757

38-
This will actually kill _all_ experiment profiles running. To specify a specific profile, use its job-id:
58+
Or target a specific profile by its job ID:
3959

4060
```bash
4161
pio kill --job-id <job-id>
4262
```
43-

0 commit comments

Comments
 (0)