Merge branch 'main' of github.com:Pioreactor/docs.pioreactor

Pioreactor · Apr 2, 2024 · 7ab6544 · 7ab6544
2 parents 784f9f4 + d362fba
commit 7ab6544
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 7 deletions.
diff --git a/developer-guide/04-Automations/05-events.md b/developer-guide/04-Automations/05-events.md
@@ -41,10 +41,14 @@ You can create custom automations, too:
 ```python
 From pioreactor.automations.events import AutomationEvent
 
-class ExampleEvent(AutomationEvent):
+class MyExampleEvent(AutomationEvent):
     pass
 
 
-event = ExampleEvent("my message", {'some_data': 1.0})
-
+class MyAutomation(...):
+    ...
 
+    def execute(self):
+        ...
+        event = MyExampleEvent("my message", {'some_data': 1.0})
+        return event
diff --git a/user-guide/01-getting-started/01c-software-set-up.mdx b/user-guide/01-getting-started/01c-software-set-up.mdx
@@ -53,7 +53,7 @@ What is an image file? It's a file that contains all the required software prein
 6. Click **Edit settings**:
     <img src="/img/user-guide/choose-edit-settings.png" width="525" alt="Click edit settings" style={{margin: "auto", display:"block"}} />
 
-    1. Check **Set hostname**. Input a unique name for this Pioreactor. Some names that we use for our first Pioreactor: `pioreactor1`, or `leader`, or `pio1`. _Don't_ use `pioreactor`.
+    1. Check **Set hostname**. Input a unique name for this Pioreactor. Some names that we use for our first Pioreactor: `pioreactor1`, or `leader`, or `pio1`. _Don't_ use `pioreactor` or `raspberrypi`.
     3. Check **Set username and password**. Enter the following:
         -   **username**: `pioreactor`.
         -   **password**: `raspberry`.

diff --git a/user-guide/03-Extending your Pioreactor/20-updating-software.md b/user-guide/03-Extending your Pioreactor/20-updating-software.md
@@ -108,7 +108,7 @@ Each time we release a new Pioreactor version, we create a bundle of the require
 
 8. To update your workers, first we will distribute the release file to all workers:
    ```
-   pios cp release_xx.xx.xx.zip
+   pios cp release_xx.xx.xx.zip -y
    ```
 
 9. Finally, run the following to update the software on the workers:

diff --git a/user-guide/29-Automations/02-dosing-automations.md b/user-guide/29-Automations/02-dosing-automations.md
@@ -78,4 +78,12 @@ In the Pioreactor software, the transition between environments is controlled by
 *   1 peristaltic pump
 *   A source and sink, with the pump in-between.
 
-This automation moves a preset amount of `volume` every `duration` minutes using a pump. You choose the start and end points of the tube!
+This automation moves a preset amount of `volume` every `duration` minutes using a pump. You choose the start and end points of the tube!
+
+
+:::info
+
+How does the vial maintain a constant volume throughout operation? When liquid is added, say 1ml, the volume rises an additional 1ml. Then 1ml of liquid is removed via efflux, but **then the efflux pump runs again for an additional few seconds**. The efflux pump is run for an additional few seconds to eliminate any volume deltas (for example, if the volume added is greater than the volume removed due to pumping errors). Otherwise, the deltas accumulate and the vial can overflow. This additional step helps guarantee
+ that that volume of liquid never exceeds the end of the efflux tube.
+
+:::
diff --git a/user-guide/99-common-questions.mdx b/user-guide/99-common-questions.mdx
@@ -247,7 +247,7 @@ On a computer that is connected to the internet, download the `.whl` file from t
 
 ##### To upgrade the Pioreactor software
 
-See steps [here](/user-guide/updating-software#updating-use-release-archives).
+See steps [here](/user-guide/updating-software#method-2-update-using-a-zip-file-and-the-ui).
 
 #### If I have multiple Pioreactor leaders on my network, what leader does `http://pioreactor.local` point to?