Skip to content

Commit c24d729

Browse files
docs
1 parent 23d78b1 commit c24d729

3 files changed

Lines changed: 82 additions & 1 deletion

File tree

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,38 @@ remove_waste:
290290
volume: 1.5
291291
```
292292

293+
To override Turbidostat's default biomass signal inside an experiment profile, set `biomass_signal` directly in the start options or use `config_overrides` when you want to change the config-backed default for that run:
294+
295+
```yaml
296+
common:
297+
jobs:
298+
dosing_automation:
299+
actions:
300+
- type: start
301+
options:
302+
automation_name: turbidostat
303+
target_biomass: 2.0
304+
exchange_volume_ml: 1.0
305+
biomass_signal: od_fused
306+
```
307+
308+
```yaml
309+
common:
310+
jobs:
311+
dosing_automation:
312+
actions:
313+
- type: start
314+
options:
315+
automation_name: turbidostat
316+
target_biomass: 2.0
317+
exchange_volume_ml: 1.0
318+
config_overrides:
319+
dosing_automation.turbidostat:
320+
biomass_signal: od
321+
```
322+
323+
Use the current section name `dosing_automation.turbidostat`. Older documentation may refer to `turbidostat.config`, but current releases migrate that legacy location to the new one.
324+
293325
## Defining top-level parameters with `inputs`
294326

295327
Surface key constants in an `inputs` section so collaborators can tweak them. Use the names in expressions anywhere in the profile:

user-guide/03-Extending your Pioreactor/20-updating-software.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ When a new software version is released by our team, you will see a red "badge"
2323

2424
Upon visiting the _Updates_ page, you can see what version you have installed, and the latest version published by us. You can also read the changelog to see what improvements we've made in the latest releases.
2525

26+
If a release mentions Turbidostat biomass signal selection changes, see [Dosing automations](/user-guide/dosing-automations) for the current `biomass_signal` behavior, override options, and migration notes.
27+
2628
![](/img/user-guide/03-extending-your-pioreactor/20-updating-software/version_installed_vs_latest.png)
2729

2830

user-guide/29-Automations/02-dosing-automations.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The current turbidostat fields in the UI are:
5858

5959
- `exchange volume`: how much media and waste to move in each dilution cycle, in mL.
6060
- `target biomass`: the biomass threshold that triggers a dilution cycle.
61-
- `biomass signal`: which biomass estimate to monitor. `auto` will prefer `od_fused` when an active OD fused estimator is available, then `od` when an active OD calibration is available for the resolved signal channel, and otherwise falls back to `normalized_od`.
61+
- `biomass signal`: which biomass estimate to monitor. The UI defaults this to `auto`.
6262

6363
When `biomass signal` is set to:
6464

@@ -67,6 +67,48 @@ When `biomass signal` is set to:
6767
- `od`: the automation compares against calibrated OD from the resolved OD channel.
6868
- `auto`: the automation chooses the most specific available signal automatically.
6969

70+
When `biomass signal` is `auto`, the selection order is:
71+
72+
1. `od_fused`, when an active `od_fused` estimator is available.
73+
2. `od`, when an active OD calibration is available for the resolved photodiode angle.
74+
3. `normalized_od`, when neither of the above is available.
75+
76+
What "active" means:
77+
78+
- An active `od_fused` estimator is the estimator currently marked active in **Estimators** for the `od_fused` device.
79+
- An active `od` calibration is the calibration currently marked active for the OD device that matches the photodiode angle Turbidostat resolves for your setup, such as `od90` or `od135`.
80+
- If you have multiple non-reference OD signal channels configured, Turbidostat resolves `od` using the lowest-numbered signal channel and logs a warning. In that case, `od_fused` or `normalized_od` is usually a better choice.
81+
82+
If the selected biomass signal is not publishing fresh data, Turbidostat cannot make a dosing decision. In practice this means:
83+
84+
- `od_reading` must be running.
85+
- `od` and `od_fused` data must be fresh. Readings older than 5 minutes are treated as stale, and the automation will warn instead of continuing with a dilution based on old data.
86+
87+
### Overriding the biomass signal
88+
89+
Most users can leave the UI default at `auto`. Override it only when you want to force Turbidostat to use a specific biomass estimate.
90+
91+
To set a persistent default in `config.ini`, use the per-automation section:
92+
93+
```ini
94+
[dosing_automation.turbidostat]
95+
biomass_signal=od_fused
96+
```
97+
98+
Legacy versions used:
99+
100+
```ini
101+
[turbidostat.config]
102+
biomass_signal_override=od_fused
103+
```
104+
105+
Current releases use `biomass_signal` under `[dosing_automation.turbidostat]` instead. During software updates, legacy values are migrated when present, and systems without a prior setting are seeded with `biomass_signal=auto`.
106+
107+
You can also override this per run:
108+
109+
- In the UI, the Turbidostat form starts with `biomass signal = auto`. You can change it before launching the automation.
110+
- In the advanced config UI, automation-specific overrides now use section names like `[dosing_automation.turbidostat]`.
111+
70112
### PID Morbidostat
71113

72114
**Requires:**
@@ -128,6 +170,11 @@ You can edit these parameters in your config.ini files. For dosing runs started
128170
- `max_subdose`: the maximum volume to add in a single dose. If the volume to add is greater than this value, the volume will be divided into smaller doses.
129171

130172

173+
#### Section `[dosing_automation.turbidostat]`
174+
175+
- `biomass_signal`: the default biomass signal used by Turbidostat when you don't pass an explicit per-run value. Valid values are `auto`, `normalized_od`, `od_fused`, and `od`.
176+
177+
131178
#### Section `[bioreactor]`
132179

133180
- `max_working_volume_ml`: determined by the volume that just touches the outflow tube. I.e. if you were to keep running the waste pump, what would the stable volume be.

0 commit comments

Comments
 (0)