Skip to content

Commit a0546c0

Browse files
fused and more links
1 parent 94027e7 commit a0546c0

File tree

7 files changed

+100
-35
lines changed

7 files changed

+100
-35
lines changed
97.5 KB
Loading

user-guide/02-Experiment basics/05-Activities.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ slug: /activities
44
hide_table_of_contents: true
55
---
66

7-
Below is a list of activities that come available with the Pioreactor. Additionally, you can add activities using plugins. [Read more about using plugins](/user-guide/using-community-plugins).
7+
Below is a list of built-in activities that come with the Pioreactor. Additionally, you can add activities using plugins. [Read more about using plugins](/user-guide/using-community-plugins).
88

9-
- **Stirring**: this starts the stirring in the Pioreactor. After starting to stir, you can change the stirring speed in the Settings tab. You can modify the default stirring speed in the configuration settings. We recommend keeping the stirring range of 150 RPM to 600 RPM.
9+
- **Stirring**: starts the stirring in the Pioreactor. After starting, you can change the stirring speed in the **Settings** tab. You can modify the default stirring speed in the configuration settings. We recommend keeping the stirring range between 150 RPM and 600 RPM.
1010

11-
- **Optical density**: this turns on the system that measures culture density. Readings will start to populate the _Experiment Overview_ page. It's useful to inspect the first few minutes of readings to ensure the readings are as expected (e.g., the readings aren't erratic, and the stirring speed is appropriate, etc.).
11+
- **Optical density**: turns on the system that measures culture density. Readings will start to populate the **Experiment Overview** page. It's useful to inspect the first few minutes to ensure the readings look reasonable (for example, they aren't erratic and the stirring speed is appropriate). Read more about [optical density and normalization](/user-guide/od-normal-growth-rate).
1212

13-
- **Growth Rate**: this activity requires that stirring and optical density be running as well. This starts the calculation of a normalized optical density, and the implied growth rate. Both calculations will populate the _Experiment Overview_ page.
13+
- **Growth Rate**: this activity requires that stirring and optical density be running as well. It starts the calculation of a normalized optical density and the implied growth rate. Both calculations will populate the **Experiment Overview** page. Read more about [growth-rate modelling](/user-guide/growth-rate-modelling).
1414

1515
- **Temperature automation**: turning on a temperature automation will start collecting temperature readings. For example, the **Thermostat** automation will use a feedback loop to stabilize the Pioreactor to a set temperature. Pausing an automation will cease both any active heating and temperature data collection. Stopping an automation will stop the heating and temperature collection. To change a running temperature automation, use the "Change Temperature Automation" button. Read more about specific [temperature automations](/user-guide/temperature-automations).
1616

17-
- **Dosing automation**: turning on a dosing automation to start listening periodically for dosing triggers. A dosing automation requires at least 1 pump to be available and calibrated. [More about using pumps](/user-guide/using-pumps). Pausing a dosing automation will stop any currently, and future, dosing occurring until the automation is unpaused. Read more about the different types of [dosing automations](/user-guide/dosing-automations).
17+
- **Dosing automation**: turning on a dosing automation starts listening periodically for dosing triggers. A dosing automation requires at least 1 pump to be available and calibrated. [More about using pumps](/user-guide/using-pumps). Pausing a dosing automation will stop any current and future dosing until the automation is unpaused. Read more about the different types of [dosing automations](/user-guide/dosing-automations).
1818

19-
- **LED automation**: turning on a LED automation to start listening periodically for LED change triggers. Read more about [LED automations](/user-guide/led-automations).
19+
- **LED automation**: turning on an LED automation starts listening periodically for LED change triggers. Read more about [LED automations](/user-guide/led-automations).

user-guide/02-Experiment basics/09-od-normal-growth-rate.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import AssemblyInstructionBlock from '@site/src/components/AssemblyInstructionBl
99
import Highlight from '@site/src/components/Highlight';
1010
import Admonition from '@theme/Admonition';
1111

12-
### Background on optical density
12+
### Background on optical density
1313

14-
The interaction of light within samples of suspended microorganisms will differ from light passing through concentrated solutions. Instead of being absorbed, light is scattered by the cells in suspension. This scattered light is measured as **optical density (OD)**. As turbidity increases, more scattering occurs, resulting in a higher OD reading.
14+
Light passing through a culture behaves differently than light passing through a clear solution. Instead of being absorbed, light is scattered by the cells in suspension. This scattered light is measured as **optical density (OD)**. As turbidity increases, more scattering occurs, resulting in a higher OD reading.
1515

1616
![](/img/user-guide/02-experiment-basics/09-od-normal-growth-rate/absorption_vs_od.png)
1717

@@ -21,9 +21,9 @@ Looking to calibrate for OD600 readings? [Visit this page](/user-guide/calibrate
2121

2222
### Normalization
2323

24-
Due to manufacturing variables such as differences in LED strength and sensitivity, the raw OD readings can't be compared against each other. Instead, we use the _normalization_ technique described below:
24+
Due to manufacturing variation (LED strength and sensor sensitivity), raw OD readings can't be compared directly across devices. Instead, we use the _normalization_ technique described below:
2525

26-
A series of initial OD readings are averaged to produce a _reference value_ (denominator). New OD readings after the reference value are normalized using the following simple equation:
26+
A series of initial OD readings are averaged to produce a _reference value_ (baseline). New OD readings after the reference value are normalized using the following simple equation:
2727

2828
$$
2929
\frac{\normalsize \text{latest\thickspace OD}}{\normalsize \text{reference\thickspace OD}}=\text{normalized\thickspace OD}
@@ -43,25 +43,25 @@ It's difficult to compare raw OD readings since the starting values are differen
4343

4444
$\frac{\small 0.033}{\small 0.030}=1.1$
4545

46-
Culture growth by 1.1x.
46+
Culture has grown by 1.1x.
4747

4848
###### Pioreactor2
4949

5050
$\frac{\small 0.015}{\small 0.010}=1.5$
5151

52-
Culture growth by 1.5x.
52+
Culture has grown by 1.5x.
5353

5454
We can more accurately compare culture growth using these ratios as opposed to using the raw OD values.
5555

5656
:::tip
57-
Because of the way we defined _normalized_ optical density, it has the following easy interpretation: its the multiplicative amount the culture has changed by. So if the normalized OD is 2.0, the culture has doubled its initial concentration, i.e. doubled the population since the volume is fixed. This also works for traditional OD600 measurements: if your initial sample has OD600 equal to 0.45, then a normalized OD of 2.0 is the same as an OD600 of twice that, or 0.90. (Generally...).
57+
Because of the way we defined _normalized_ optical density, it has the following easy interpretation: it's the multiplicative amount the culture has changed by. So if the normalized OD is 2.0, the culture has doubled its initial concentration, i.e. doubled the population since the volume is fixed. This interpretation also maps to traditional OD600 measurements: if your initial sample has OD600 equal to 0.45, then a normalized OD of 2.0 is approximately an OD600 of twice that, or 0.90.
5858
:::
5959

6060
### Blanking
6161

6262
While basic normalization accounts for initial OD differences, it does not consider the optical density of the media itself. For a more accurate growth rate calculation, you can blank your sample.
6363

64-
Blanking your vials is recommended for experiments that begin with low OD readings (ex. inoculating small amounts of yeast). By blanking, you are able to observe the OD of only the microorganism of interest.
64+
Blanking your vials is recommended for experiments that begin with low OD readings (e.g., inoculating small amounts of yeast). By blanking, you observe the OD of only the microorganism of interest.
6565

6666
As an example, let's consider the same data as above, but this time we have information on the blank ODs:
6767

@@ -70,7 +70,7 @@ As an example, let's consider the same data as above, but this time we have info
7070
| Pioreactor1 | 0.025 | 0.030 | 0.005 | 0.033 |
7171
| Pioreactor2 | 0.005 | 0.010 | 0.005 | 0.015 |
7272

73-
We can now subtract the _blank_ values from the _latest OD_ and _reference OD_ values:
73+
We can now subtract the _blank_ values from both the _latest OD_ and _reference OD_ values:
7474

7575
$$
7676
\frac{\normalsize \text{latest\thickspace OD}-\text{blank\thickspace OD}}{\normalsize \text{reference\thickspace OD}-\text{blank\thickspace OD}}=\text{blanked\thickspace normalized\thickspace OD}
@@ -80,24 +80,24 @@ $$
8080

8181
$\frac{\small 0.033-0.025}{\small 0.030-0.025}=1.6x$
8282

83-
Culture growth by 1.6x.
83+
Culture has grown by 1.6x.
8484

8585
###### Pioreactor2
8686

8787
$\frac{\small 0.015-0.005}{\small 0.010-0.005}=2x$
8888

89-
Culture growth by 2x.
89+
Culture has grown by 2x.
9090

9191
By accounting for the OD of the blank media, we are able to calculate a more accurate growth rate.
9292

9393
### Growth rate
9494

95-
We inoculated two vials with a drop of re-hydrated yeast, and tracked their growth at temperatures 27°C and 35°C. The following normalized optical density chart was generated by the Pioreactor:
95+
We inoculated two vials with a drop of re-hydrated yeast, and tracked their growth at temperatures 27°C and 35°C. The UI shows the following normalized optical density chart:
9696

9797
![](/img/user-guide/02-experiment-basics/09-od-normal-growth-rate/temp_normal_od.png)
9898

9999

100-
From the normalized optical density, an implied growth rate graph is generated. The relationship between the implied growth rate, $\text{gr}$ and the normalized optical density, $\text{nOD}$ is exponential, defined by the following equation:
100+
From normalized optical density, the UI also computes an implied growth rate. The relationship between the implied growth rate, $\text{gr}$, and the normalized optical density, $\text{nOD}$, is exponential and can be written as:
101101

102102
$$
103103
\text{nOD}(t) = \exp{ \left( \int_0^t \text{gr}(s)ds \right)}
@@ -109,16 +109,16 @@ $$
109109
\text{gr}(t)= \frac{ \text{nOD}'(t)} {\text{nOD}(t)}
110110
$$
111111

112-
which plainly states that the growth rate is the rate of change of the size of the culture, normalized by the size of the culture.
112+
This states that the growth rate is the rate of change of the culture size, normalized by the culture size.
113113

114114

115-
This rate can give insight on the state of your culture under different external conditions.
115+
This rate helps compare the state of your culture under different conditions (temperature, media, etc.).
116116

117117
![](/img/user-guide/02-experiment-basics/09-od-normal-growth-rate/temp_growth_rate.png)
118118

119-
These graphs can be interpreted in 4 phases:
120-
* The lag phase: No observed growth, but high cell activity. In this stage, cells are in a nutrient rich environment and are preparing for growth by synthesizing proteins and other necessary molecules.
121-
* Exponential (or log) phase: Cells are now dividing and doubling in numbers after each generation time. Generation times are dependent on the species you are using for your experiment.
119+
These graphs can be interpreted in four phases:
120+
* The lag phase: Little observed growth, but high cell activity. Cells acclimate to a nutrient-rich environment and prepare for division.
121+
* Exponential (or log) phase: Cells divide and double at a roughly constant rate. Generation times depend on species and conditions.
122122
* Stationary phase: Eventually the growth of cells reaches a plateau as nutrients are used up and waste products accumulate. At this point, the number of dividing cells will equal the number of dying cells.
123123
* Decline (or death) phase: As nutrients are depleted, cell growth slows while cell death increases.
124124

@@ -128,7 +128,7 @@ Here's how these phases would apply to our graphs, focusing on the 35°C vial:
128128

129129
![](/img/user-guide/02-experiment-basics/09-od-normal-growth-rate/nod_interpretation.png)
130130

131-
Some things to note:
131+
Some things to note:
132132
* The lag phase can be detected easily in the growth rate graph, as the rate is stable and doesn't begin increasing until a bit after 6 PM. This is not easily determined in the nOD graph, since at this point the overall turbidity of the culture is low.
133133
* The exponential phase occurs when the growth rate is high/increasing.
134134
* When the culture reaches the stationary phase, growth rate drops to 0 since the culture is no longer growing in size. The turbidity is constant.
@@ -142,10 +142,10 @@ When working with **small amounts** of a microorganism, or when using very turbi
142142
<AssemblyInstructionBlock title="How to record a blank" images={["user-guide/02-experiment-basics/04-set-up-an-experiment/calibrate.png","user-guide/02-experiment-basics/04-set-up-an-experiment/blank.png"]}>
143143

144144
1. Insert your sterile vial containing media into the Pioreactor before inoculating with your species of interest.
145-
2. On the website, click the _Pioreactors_ tab on the left-hand menu, and choose one of the active Pioreactors.
146-
3. Select _Calibrate_, and under the _Blanks_ tab, click _Start_. The Pioreactor will now record the optical density of the blank vial.
145+
2. In the UI, click the **Pioreactors** tab on the left-hand menu, and choose one of the active pioreactors.
146+
3. Select **Calibrate**, and under the **Blanks** tab, click _Start_. The Pioreactor will now record the optical density of the blank vial.
147147
4. Repeat for all the Pioreactors to be used.
148148
* A notification will appear when a Pioreactor has finished blanking.
149-
6. You can now inoculate your vials and begin your experiment.
149+
5. You can now inoculate your vials and begin your experiment.
150150

151151
</AssemblyInstructionBlock>

user-guide/02-Experiment basics/10-manual-led-dosing.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ hide_table_of_contents: true
88

99
### Dosing
1010

11-
You can run the pumps from the Pioreactor UI. These are NOT automations, but rather simple actions to use to set up an experiment, perform cleaning, or intervene in an experiment.
11+
You can run the pumps from the Pioreactor UI. These are not automations, but simple actions used to set up an experiment, perform cleaning, or intervene mid-run. For automated workflows, see [dosing automations](/user-guide/dosing-automations).
1212

1313
#### Cycling
1414

15-
Under the _Dosing_ tab, you run the media pump or the alt-media pump _and concurrently the waste pump_. This is called _cycling_. By running the waste pump simultaneously, the vial will avoid overflow. You can cycle for a set duration of time.
15+
Under the **Dosing** tab, you run the media pump or the alt-media pump _and concurrently the waste pump_. This is called _cycling_. Running the waste pump simultaneously helps avoid overflow. You can cycle for a set duration of time.
1616

1717
![UI showing how to cycle media.](/img/user-guide/02-experiment-basics/10-manual-led-dosing/cycle_media.png)
1818

1919
Cycling is good for cleaning pumps, priming tubes with media, or filling your vial with media.
2020

2121
#### Specific control of pumps
2222

23-
Under the _Dosing_ tab, you can also run specific pumps (media, waste, and alt-media) for a specific duration, volumes (if calibrated), or continuously. The latter will run until the *Stop* button is pressed.
23+
Under the **Dosing** tab, you can also run specific pumps (media, waste, and alt-media) for a set duration, volume (if calibrated), or continuously. The latter will run until the *Stop* button is pressed. Read more about [using pumps](/user-guide/using-pumps).
2424

2525
:::caution
2626
Careful not to overflow your vial! The Pioreactor doesn't know how much liquid is currently in the vial. Stay well below the max volume of the vial for safety.
@@ -30,13 +30,13 @@ Careful not to overflow your vial! The Pioreactor doesn't know how much liquid i
3030

3131
#### Adjustments from manual changes
3232

33-
Sometimes you may want to add or remove liquid from the vial manually. These changes can be recorded by using the _Manual adjustments_ form under the _Dosing_ tab. These do not run the pumps, but will log the adjustments. This is useful for recording adjustments into the database, and keeping metrics accurate.
33+
Sometimes you may want to add or remove liquid from the vial manually. These changes can be recorded by using the **Manual adjustments** form under the **Dosing** tab. This does not run the pumps, but logs the adjustments. This keeps metrics accurate.
3434

3535
----
3636

3737

3838
### LEDs
3939

40-
Under the _LED_ tab, you can update specific intensities of the LEDs.
40+
Under the **LED** tab, you can update specific intensities of the LEDs. For automated light schedules, see [LED automations](/user-guide/led-automations).
4141

42-
![UI showing how to change LEDs.](/img/user-guide/02-experiment-basics/10-manual-led-dosing/change_leds.png)
42+
![UI showing how to change LEDs.](/img/user-guide/02-experiment-basics/10-manual-led-dosing/change_leds.png)

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Experiment profile schema and syntax
33
slug: /experiment-profiles-schema
4-
hide_table_of_contents: true
54
---
65

76
Experiment profiles are YAML files that choreograph jobs across your Pioreactor cluster. This page documents the syntax the UI validates against and the constructs available when you are editing a profile directly.

user-guide/30-Advanced/20-estimators.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ slug: /estimators
44
sidebar_label: Estimators
55
description: Learn how Pioreactor estimators turn raw sensor signals into derived measurements.
66
sidebar_class_name: sidebar-item--updated
7+
hide_table_of_contents: true
78
---
89

910
Estimators turn raw sensor signals into derived measurements that are more useful for experiments. They are similar to calibrations in lifecycle (created through a protocol, saved to disk, optionally set active), but they solve a different problem: they combine or transform measurements from multiple sensors into a single estimate.

0 commit comments

Comments
 (0)