You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: user-guide/03-Extending your Pioreactor/04-Experiment Profiles/03-start-stop-profiles.md
+33-14Lines changed: 33 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,41 +3,60 @@ title: Running and stopping experiment profiles
3
3
slug: /start-stop-experiment-profiles
4
4
---
5
5
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.
7
7
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
9
9
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.
11
11
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
+

13
+
14
+
2.**Pick the profile to run.** Use the dropdown to select the YAML profile you want to execute.
15
+
16
+

17
+
18
+
3.**Start the profile.** Click **Run profile** to launch it immediately.
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.
14
24
:::
15
25
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
+

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
+

37
+
38
+
## Run profiles from the CLI
39
+
40
+
You can also launch profiles from the leader's terminal:
17
41
18
42
```bash
19
43
pio run experiment_profile execute </path/to/experiment_profile/.yaml><experiment_name>
20
44
```
45
+
21
46
For example:
22
47
23
48
```bash
24
49
pio run experiment_profile execute /home/pioreactor/.pioreactor/experiment_profiles/chemostat_in_out_2.yaml 'level tests'
25
50
```
26
51
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:
33
53
34
54
```bash
35
55
pio kill --job-name experiment_profiles
36
56
```
37
57
38
-
This will actually kill _all_ experiment profiles running. To specify a specific profile, use its job-id:
0 commit comments