Skip to content

Commit 6451fb2

Browse files
adding calibrations dir
1 parent 086f45f commit 6451fb2

File tree

4 files changed

+44
-33
lines changed

4 files changed

+44
-33
lines changed

user-guide/03-Extending your Pioreactor/05-calibrate-od600.md renamed to user-guide/03-Extending your Pioreactor/02-Calibrations/05-calibrate-od600.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -50,25 +50,7 @@ By default, we fit the calibration curve with a polynomial. You can choose the d
5050

5151
![Final data points with generated curve.](/img/user-guide/03-extending-your-pioreactor/05-calibrate-od600/od_cal_45_deg_with_curve.png)
5252

53-
## Using calibrations in your experiments
54-
55-
Calibrations are applied automatically during OD Readings. That is, after performing a calibration, your future experiments that use optical density readings will use the post-calibration values and be displayed in the UI and saved to the database.
56-
57-
To change the OD calibration you wish to use for an experiment, visit the Calibrations page, select the calibration you wish to use, and select "Set Active". Only one calibration can be Active at a time.
58-
59-
![Final data points on OD calibration.](/img/user-guide/03-extending-your-pioreactor/05-calibrate-od600/od_cal_active.png)
60-
61-
You can disable calibrations by changing the OD device to have no _Active_ calibration in the Calibrations page.
62-
63-
## Editing your previous calibrations
64-
65-
The calibrations are saved as a YAML file on your Pioreactor. You can edit these files directly on the command line. If you want to re-analyze the dataset, you can use the following tool:
66-
```
67-
pio calibrations analyze --device od --name <name of your calibration>
68-
```
69-
70-
## Sharing calibrations
71-
72-
Since the calibrations are just YAML files, you can easily share existing calibrations to other Pioreactors.
53+
## Managing calibrations
7354

55+
Once you have an OD calibration, you can set it active, edit it, and share it from the Calibrations page. See [Managing calibrations](/user-guide/managing-calibrations) for the full workflow.
7456

user-guide/03-Extending your Pioreactor/08-hardware-calibrations.md renamed to user-guide/03-Extending your Pioreactor/02-Calibrations/08-hardware-calibrations.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,4 @@ There are three pumps on the Pioreactor: media, alt-media, and waste. You don't
6464

6565
## Managing calibrations
6666

67-
From both the UI and the command line, you can manage your Pioreactor's calibrations.
68-
69-
![Calibrations page showing filters, table, and chart.](/img/user-guide/03-extending-your-pioreactor/08-hardware-calibrations/calibrations-page.png)
70-
71-
**In the UI**
72-
- Use the `Pioreactor` and `Device` filters at the top of the Calibrations page to focus on a specific unit and hardware type. Toggle **Only Active calibrations** to hide everything except the curve currently in use.
73-
- Click any calibration row to open its detail view. Use **Set active** to mark that calibration as the one the Pioreactor will use for that device (only one calibration can be active per device per Pioreactor). Use **Set inactive** to clear it and disable calibration for that device.
74-
- The chart in both the list view and detail view has a download icon—click it to export a PNG of the calibration curve for lab notes. The top-level **Download all calibrations** button grabs all calibration YAML files for backup.
75-
- To edit a calibration, open its detail view and choose **View YAML**. Make small changes, save the YAML, and re-upload it via **Upload calibration** (or edit the YAML on-disk and use `pio calibrations display` to confirm before setting it active).
76-
77-
**From the command line**
78-
- List what you have with `pio calibrations list` or scope to a single device with `pio calibrations list --device <device>`.
79-
- Set which calibration is active with `pio calibrations set-active --device <device> --name <calibration_name>`. Omit `--name` to clear the active calibration for that device.
67+
For setting active calibrations, editing YAML, and sharing backups, see [Managing calibrations](/user-guide/managing-calibrations).
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Managing calibrations
3+
slug: /managing-calibrations
4+
hide_table_of_contents: true
5+
---
6+
7+
Once you have one or more calibrations (stirring, pumps, OD), you can set which one is active, export it, edit it, or share it.
8+
9+
## Using calibrations in experiments
10+
11+
Calibrations are applied automatically whenever a device has an active calibration. For OD readings, that means future experiments will use the post-calibration values in the UI and database.
12+
13+
To change which calibration is active, visit the Calibrations page, select the calibration you want, and choose **Set active**. Only one calibration can be active per device on a Pioreactor at a time. You can disable calibrations by clearing the active calibration for that device.
14+
15+
## Managing calibrations in the UI
16+
17+
![Calibrations page showing filters, table, and chart.](/img/user-guide/03-extending-your-pioreactor/08-hardware-calibrations/calibrations-page.png)
18+
19+
- Use the `Pioreactor` and `Device` filters at the top of the Calibrations page to focus on a specific unit and hardware type. Toggle **Only Active calibrations** to hide everything except the curve currently in use.
20+
- Click any calibration row to open its detail view. Use **Set active** to mark that calibration as the one the Pioreactor will use for that device (only one calibration can be active per device per Pioreactor). Use **Set inactive** to clear it and disable calibration for that device.
21+
- The chart in both the list view and detail view has a download icon. Click it to export a PNG of the calibration curve for lab notes. The top-level **Download all calibrations** button grabs all calibration YAML files for backup.
22+
- To edit a calibration, open its detail view and choose **View YAML**. Make small changes, save the YAML, and re-upload it via **Upload calibration** (or edit the YAML on-disk and use `pio calibrations display` to confirm before setting it active).
23+
24+
## Managing calibrations from the command line
25+
26+
- List what you have with `pio calibrations list` or scope to a single device with `pio calibrations list --device <device>`.
27+
- Set which calibration is active with `pio calibrations set-active --device <device> --name <calibration_name>`. Omit `--name` to clear the active calibration for that device.
28+
29+
## Editing and sharing calibrations
30+
31+
Calibrations are saved as YAML files on your Pioreactor. You can edit these files directly on the command line or in the UI.
32+
33+
If you want to re-analyze an OD calibration dataset, use:
34+
```
35+
pio calibrations analyze --device od --name <name of your calibration>
36+
```
37+
38+
Since the calibrations are just YAML files, you can easily share existing calibrations to other Pioreactors.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
collapsed: true
2+
collapsible: true
3+
label: "Calibrations"

0 commit comments

Comments
 (0)