Skip to content

Commit 69f30e2

Browse files
adding note on start/stop profiles
1 parent 9f05862 commit 69f30e2

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Running and stopping experiment profiles
3+
slug: /start-stop-experiment-profiles
4+
---
5+
6+
### Running an experiment profile
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.
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).
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.
14+
:::
15+
16+
You can also run profiles from the leader's command line. To run a profile, use:
17+
18+
```bash
19+
pio run experiment_profile execute </path/to/experiment_profile/.yaml> <experiment_name>
20+
```
21+
For example:
22+
23+
```bash
24+
pio run experiment_profile execute /home/pioreactor/.pioreactor/experiment_profiles/chemostat_in_out_2.yaml 'level tests'
25+
```
26+
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:
33+
34+
```bash
35+
pio kill --job-name experiment_profiles
36+
```
37+
38+
This will actually kill _all_ experiment profiles running. To specify a specific profile, use it's job-id:
39+
40+
```bash
41+
pio kill --job-id <job-id>
42+
```
43+

user-guide/03-Extending your Pioreactor/04-Experiment Profiles/10-experiment-profiles-schema.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Experiment profiles schema
33
slug: /experiment-profiles-schema
44
---
55

6-
76
Below is a schema for experiment profiles. We also do a run-time check.
87

98
```yaml
109
# Main structure of the experiment profile
1110
experiment_profile_name: <string> # Name of the experiment profile
1211

12+
1313
# Metadata section (optional)
1414
metadata:
1515
author: <string> # Author of the experiment profile
@@ -20,6 +20,12 @@ plugins:
2020
- name: <string> # Name of the plugin
2121
min_version: <string> # Minimum required version of the plugin
2222

23+
# inputs for variables that can be used in expressions (optional)
24+
inputs:
25+
var1: value1
26+
var2: value2
27+
28+
2329
# Common jobs section (optional)
2430
# Jobs that are common for all Pioreactors
2531
common:

0 commit comments

Comments
 (0)