You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: developer-guide/07-Plugins/03-plugin-as-python-package.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -340,6 +340,15 @@ include <PLUGIN_NAME>/LEADER_ONLY
340
340
341
341
For an example, see the [logs2slack](https://github.com/Pioreactor/pioreactor-logs2slack) plugin's repository.
342
342
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
+
343
352
## Create a Python package on PyPI
344
353
345
354
Create an account on [https://pypi.org/](https://pypi.org/). Make sure to verify your email.
Copy file name to clipboardExpand all lines: user-guide/01-getting-started/02-software-set-up.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,15 +20,15 @@ Before you get started, you'll need to have the following:
20
20
21
21
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))
22
22
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.
24
24
4. A computer with internet access and ability to read & write to a microSD card
25
25
26
26
:::
27
27
28
-
### Setting up your Raspberry Pi
28
+
### Setting up your Raspberry Pi's SD Card
29
29
30
30
31
-
We'll start your blank microSD card.
31
+
We'll start with your blank microSD card.
32
32
33
33
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.
Copy file name to clipboardExpand all lines: user-guide/03-Extending your Pioreactor/06a-using-community-plugins.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ You can uninstall plugins from the same page, too. These will remove the action
48
48
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>`
49
49
3. Once the .whl file is on the Pioreactor, use the following to install the plugin:
50
50
```
51
-
pio plugin install <name-of-plugin> --source <location of .whl file>
51
+
pio plugins install <name-of-plugin> --source <location of .whl file>
52
52
```
53
53
For example:
54
54
```
@@ -57,4 +57,4 @@ You can uninstall plugins from the same page, too. These will remove the action
57
57
58
58
## Alternative: putting Python files in the the `plugins` folder
59
59
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).
Copy file name to clipboardExpand all lines: user-guide/30-Advanced/02-growth-rate-model.md
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,7 @@ To upload your optical density and dosing events data to the Pioreactor, you nee
95
95
96
96
:::tip
97
97
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.
99
99
100
100
101
101
:::
@@ -106,10 +106,11 @@ If using the Pioreactor UI to export datasets _Optical density_ and _Dosing even
|`od_reading`| Yes |**float**| Raw or pre-normalized optical-density measurement. |
108
108
|`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 |
109
110
110
111
:::info
111
112
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.
0 commit comments