Skip to content

Commit b7c65e0

Browse files
author
Kelly Tran
committed
clarity update
2 parents 4fb14fe + 99c27f3 commit b7c65e0

File tree

4 files changed

+29
-7
lines changed

4 files changed

+29
-7
lines changed

developer-guide/07-Plugins/03-plugin-as-python-package.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,15 @@ include <PLUGIN_NAME>/LEADER_ONLY
340340

341341
For an example, see the [logs2slack](https://github.com/Pioreactor/pioreactor-logs2slack) plugin's repository.
342342

343+
## Install package from source
344+
345+
It isn't enough to just `pip install` your package, as this will only add the script to the pioreactor system, not any extra configs you may have added.
346+
If you want to install the whole package from source you can simply run:
347+
348+
```
349+
pio plugins install <PLUGIN_NAME> --source <PLUGIN_FOLDER>
350+
```
351+
343352
## Create a Python package on PyPI
344353

345354
Create an account on [https://pypi.org/](https://pypi.org/). Make sure to verify your email.

user-guide/01-getting-started/02-software-set-up.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ Before you get started, you'll need to have the following:
2020

2121
1. A Raspberry Pi (our list of recommended Raspberry Pis is [here](/user-guide/common-questions#what-raspberry-pi-hardware-can-i-use-i-see-raspberry-pi-1-2-3-4-a-b--zero---its-confusing))
2222
2. A blank microSD card (our recommended microSD cards is [here](/user-guide/common-questions#what-microsd-cards-do-you-recommend))
23-
3. A suitable power supply for the Raspberry Pi (our recommended power supply units are [here](/user-guide/common-questions#what-power-supply-unit-do-i-need))
23+
3. A suitable power supply for the Raspberry Pi (our recommended power supply units are [here](/user-guide/common-questions#what-power-supply-unit-do-i-need)). You don't need to plug power in yet.
2424
4. A computer with internet access and ability to read & write to a microSD card
2525

2626
:::
2727

28-
### Setting up your Raspberry Pi
28+
### Setting up your Raspberry Pi's SD Card
2929

3030

31-
We'll start your blank microSD card.
31+
We'll start with your blank microSD card.
3232

3333
1. Download the [Pioreactor leader and worker image file](https://github.com/pioreactor/custopizer/releases/latest/download/pioreactor_leader_worker.zip). Leave it as a zip file - no need to unzip it.
3434

user-guide/03-Extending your Pioreactor/06a-using-community-plugins.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You can uninstall plugins from the same page, too. These will remove the action
4848
2. To get this .whl file onto a Pioreactor, use either `scp`, WinSCP, or FileZilla. Note: if you upload the .whl file to your leader Pioreactor first, you can distribute the .whl file to all your workers with `pios cp <location of .whl file>`
4949
3. Once the .whl file is on the Pioreactor, use the following to install the plugin:
5050
```
51-
pio plugin install <name-of-plugin> --source <location of .whl file>
51+
pio plugins install <name-of-plugin> --source <location of .whl file>
5252
```
5353
For example:
5454
```
@@ -57,4 +57,4 @@ You can uninstall plugins from the same page, too. These will remove the action
5757

5858
## Alternative: putting Python files in the the `plugins` folder
5959

60-
An alternative way to install a plugin is to place a Python file in the `/home/pioreactor/.pioreactor/plugins` directory on the Raspberry Pi. This is good for one-off scripts or plugins you are demoing or testing. See more [about writing and distributing plugins](/developer-guide/intro-plugins).
60+
An alternative way to install a plugin is to place a Python file in the `/home/pioreactor/.pioreactor/plugins` directory on the Raspberry Pi. This is good for one-off scripts or plugins you are demoing or testing. See more [about writing and distributing plugins](/developer-guide/intro-plugins).

user-guide/30-Advanced/02-growth-rate-model.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ To upload your optical density and dosing events data to the Pioreactor, you nee
9595

9696
:::tip
9797

98-
If using the Pioreactor UI to export datasets _Optical density_ and _Dosing event log_, these already have the correct schema. Use the "Partition output files by Pioreactor" to split the exports into individual CSV files per Pioreactor unit.
98+
If using the Pioreactor UI to export datasets _Optical density_ and _Dosing event log_, these already have the correct schema.
9999

100100

101101
:::
@@ -106,10 +106,11 @@ If using the Pioreactor UI to export datasets _Optical density_ and _Dosing even
106106
| -------------------------------- | ------------- | ------------------ | ------------------------------------------------------------------------------------------------------------- |
107107
| `od_reading` | Yes | **float** | Raw or pre-normalized optical-density measurement. |
108108
| `hours_since_experiment_created` | Yes | **float** | Elapsed hours since the experiment’s “time 0”. Use decimals for sub-hour resolution (e.g. `0.4167` ≈ 25 min). |
109+
| `pioreactor_unit` | No | **string** | use this column to partition different experiments or units |
109110

110111
:::info
111112

112-
Additional columns (sensor angle, experiment name, etc.) are ignored by the parser, so feel free to keep them. Also, the uploaded CSV should only reference a single unit, so if you have multiple units, you should have multiple CSVs.
113+
Additional columns (sensor angle, experiment name, etc.) are ignored by the parser, so feel free to keep them.
113114

114115

115116

@@ -124,6 +125,16 @@ od_reading,hours_since_experiment_created
124125
0.1749,0.402
125126
```
126127

128+
#### Multiple units example
129+
130+
```csv
131+
pioreactor_unit,od_reading,hours_since_experiment_created
132+
A,0.1725,0.397
133+
A,0.1735,0.399
134+
B,0.1249,0.397
135+
B,0.1280,0.399
136+
```
137+
127138
---
128139

129140
### 2. Dosing-events CSV
@@ -133,6 +144,8 @@ od_reading,hours_since_experiment_created
133144
| `event` | Yes | **category** (string) | Either `add_media`, `add_alt_media`, or `remove_waste`. |
134145
| `volume_change_ml` | Yes | **float** | volume change (mL) |
135146
| `hours_since_experiment_created` | Yes | **float** | Timestamp in **hours**, exactly matching the OD clock. |
147+
| `pioreactor_unit` | No | **string** | use this column to partition different experiments or units |
148+
136149

137150
#### Minimal example
138151

0 commit comments

Comments
 (0)