latest changes

.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: release docs
+
+on:
+  push:
+    tags:
+    - hatch-v*
+    - hatchling-v*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+
+    - name: Ensure latest pip
+      run: python -m pip install --upgrade pip
+
+    - name: Install env
+      run: pip install -e .
+
+    - name: Configure Git for GitHub Actions bot
+      run: |
+        git config --local user.name 'github-actions[bot]'
+        git config --local user.email 'github-actions[bot]@users.noreply.github.com'
+    - name: Build documentation
+      run: hatch run docs:build
+      env:
+        GH_TOKEN_MKDOCS_MATERIAL_INSIDERS: ${{ secrets.GH_TOKEN_MKDOCS_MATERIAL_INSIDERS }}
+
+    - name: Create archive
+      run: git archive -o site.zip gh-pages
+
+    - uses: actions/upload-artifact@v3
+      with:
+        name: documentation
+        path: site.zip
+
+  publish:
+    runs-on: ubuntu-latest
+    needs:
+    - build
+
+    steps:
+    - uses: actions/download-artifact@v3
+      with:
+        name: documentation
+
+    - name: Unpack archive
+      run: python -m zipfile -e site.zip site
+
+    - uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: site
+        commit_message: ${{ github.event.head_commit.message }}
+        enable_jekyll: false
+        allow_empty_commit: false

docs/hardware/assembly_guide.md

@@ -206,6 +206,7 @@ Inspect the case parts and panels for any damage or imperfections that may have
 ![planktoscope-assembly-023.png](../images/assembly_guide/planktoscope-assembly-023.png)
 To secure the PlanktoScope on slippery grounds using the adhesive pads, follow these steps. Gather all the necessary materials. You will need:
 
+- Time: 1 min
 - 👁 and Take the Part I
 - 🟠 Take the four adhesive pads present in the bag A.
 - 🟣 Locate the four pockets that will receive the four adhesive pads.
@@ -230,6 +231,8 @@ To secure the PlanktoScope on slippery grounds using the adhesive pads, follow t
 
 Now it's time to assemble the ground plate for the Raspberry Pi as the PlanktoScope main processing unit.
 
+- Time: 5 min
+
 ---
 
 ![planktoscope-assembly-027.png](../images/assembly_guide/planktoscope-assembly-027.png)
@@ -283,6 +286,8 @@ Keep going for each of the **four holes**.
 
 ![planktoscope-assembly-035.png](../images/assembly_guide/planktoscope-assembly-035.png)
 
+- Time: 2 min
+
 Locate the **Raspberry Pi 4 Model B** packaging.
 
 !!! warning
@@ -343,6 +348,8 @@ Push the **micro SD card** in the **Raspberry Pi** port to a point of resistance
 
 ## Chapter 6: Mount the **Raspberry Pi** on the **Part A**
 
+- Time: 1 min
+
 ![planktoscope-assembly-044.png](../images/assembly_guide/planktoscope-assembly-044.png)
 
 - ✅ Make sure to position the Raspberry Pi properly on the four standoffs screwed on the Part A.
@@ -384,6 +391,8 @@ Screw by hand a Standoff M2.5 - 16mm on the **Raspberry Pi**.
 
 ## Chapter 7: Attach the **Ribbon Cable** to the **Raspberry Pi**
 
+- Time: 2 min
+
 ![planktoscope-assembly-051.png](../images/assembly_guide/planktoscope-assembly-051.png)
 
 Locate the **Raspberry Pi Camera HQ** packaging.
@@ -451,6 +460,8 @@ Insert the **Ribbon Cable** you just detached from the **Raspberry Pi Camera** i
 
 ![planktoscope-assembly-059.png](../images/assembly_guide/planktoscope-assembly-059.png)
 
+- Time: 2 min
+
 Locate the **PlanktoScope HAT** present in **bag I**.
 
 ---
@@ -516,6 +527,7 @@ Screw the four **A4** screws through the **PlanktoScope HAT** onto the **Standof
 
 ![planktoscope-assembly-068.png](../images/assembly_guide/planktoscope-assembly-068.png)
 
+- Time: 2 min
 - Locate the **DC Power Jack** from the **Bag K**.
 - Remove the **Lock Ring** from the **DC Power Jack**
 
@@ -554,6 +566,8 @@ Screw the four **A4** screws through the **PlanktoScope HAT** onto the **Standof
 
 ![planktoscope-assembly-074.png](../images/assembly_guide/planktoscope-assembly-074.png)
 
+- Time: 2 min
+
 ---
 
 ![planktoscope-assembly-075.png](../images/assembly_guide/planktoscope-assembly-075.png)

docs/hardware/manufacturing.md

@@ -60,7 +60,7 @@ Rubio Monocoat Plus is also environmentally friendly, with a low VOC (volatile o
 
 We use Rubio Monocoat Plus as a finishing product for Valchromat.
 
-### Workflow
+### CNC workflow
 
 Here is a step-by-step guide on how to configure the feed rate and the diameter of the end mill of a CNC milling machine for the production of a workpiece, using the specified tools and configuration:
 
@@ -92,6 +92,74 @@ By following these steps, you can properly configure the feed rate and the diame
 
 ![planktoscope_case_00.png](../images/hardware/planktoscope_case_00.png)
 
+### Finnish of the case parts
+
+#### Requirements for case parts
+
+##### Case tools
+
+- Hammer
+- Air Compressor
+- Rubber gloves
+- Paper carpet pad
+- Clean piece of cotton fabric
+- Support material for drying the parts
+
+##### Case part parts
+
+- all case parts
+- Rubio Monocoat Oil Plus 2C
+- Rubio Monocoat Accelerator Component B
+- Magnets
+- Square nuts
+
+#### Clean
+
+![](../images/manufacturing_guide/IMG_20230205_114522_026.jpg)
+
+#### Stir
+
+![](../images/manufacturing_guide/IMG_20230205_121506_912.jpg)
+![](../images/manufacturing_guide/IMG_20230205_121600_985.jpg)
+
+#### Apply
+
+![](../images/manufacturing_guide/IMG_20230205_121740_849.jpg)
+![](../images/manufacturing_guide/IMG_20230205_122339_866.jpg)
+![](../images/manufacturing_guide/IMG_20230205_123231_263.jpg)
+
+#### Dry
+
+![](../images/manufacturing_guide/IMG_20230205_141852_172.jpg)
+
+#### Inserting the screws
+
+![](../images/manufacturing_guide/IMG_20230206_182410_394.jpg)
+![](../images/manufacturing_guide/IMG_20230206_194436_007.jpg)
+![](../images/manufacturing_guide/IMG_20230206_195227_606.jpg)
+
+#### Inserting the magnets
+
+![](../images/manufacturing_guide/IMG_20230206_185209_322.jpg)
+![](../images/manufacturing_guide/IMG_20230206_185827_022.jpg)
+![](../images/manufacturing_guide/IMG_20230206_190002_449.jpg)
+![](../images/manufacturing_guide/IMG_20230206_191831_326.jpg)
+![](../images/manufacturing_guide/IMG_20230206_191905_086.jpg)
+![](../images/manufacturing_guide/IMG_20230206_191911_092.jpg)
+![](../images/manufacturing_guide/IMG_20230206_192122_827.jpg)
+![](../images/manufacturing_guide/IMG_20230206_191942_446.jpg)
+![](../images/manufacturing_guide/IMG_20230206_192115_770.jpg)
+![](../images/manufacturing_guide/IMG_20230206_192048_827.jpg)
+![](../images/manufacturing_guide/IMG_20230206_190821_839.jpg)
+![](../images/manufacturing_guide/IMG_20230206_191601_928.jpg)
+![](../images/manufacturing_guide/IMG_20230206_192512_587.jpg)
+![](../images/manufacturing_guide/IMG_20230206_192610_421.jpg)
+
+#### Package Housing part
+
+![](../images/manufacturing_guide/IMG_20230206_212202_209.jpg)
+![](../images/manufacturing_guide/IMG_20230206_211854_910.jpg)
+
 ## PlanktoScope Hat
 
 Welcome to the PCB production manual for the PlanktoScope Hat!
@@ -252,22 +320,22 @@ To ensure the quality of the produced PCB, request data validation from the cust
 
 ### Assembly of the Thru-Hole components
 
-#### Requirements
+#### Thru-Hole Requirements
 
-##### Tools
+![](../images/manufacturing_guide/IMG_20230210_130428_325.jpg)
+
+##### Thru-Hole tools
 
 - [professional Soldering iron](https://en.wikipedia.org/wiki/Soldering_station)
 - [solder](https://en.wikipedia.org/wiki/Solder) with flux
-- [Helping hand](<https://en.wikipedia.org/wiki/Helping_hand_(tool)>)
+- [Helping hand](<https://en.wikipedia.org/wiki/Helping_hand_(tool)>) or [Breadboard](https://en.wikipedia.org/wiki/Breadboard)
 
-##### Parts
+##### Thru-Hole parts
 
 | Files                                                                                                                                                          | Description                     |
 | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
 | [Planktoscope-Hat-throughhole.csv](https://code.curious.bio/curious.bio/planktoscope/raw/branch/din_spec_3105_1/hardware/hat/Planktoscope-Hat-throughhole.csv) | The list of used SMD components |
 
-#### Step by step guide
-
 !!! warning
 
     When you solder this for the first time, take special care not to damage the board.
@@ -275,3 +343,241 @@ To ensure the quality of the produced PCB, request data validation from the cust
 !!! info
 
     To learn how to solder we recommend you the awesome [Comic "Soldering is easy" by Mitch Altmal, Andie Nordgren and Jeff Keyzer](https://mightyohm.com/soldercomic/)
+
+#### Soldering of the stepper motor driver
+
+![](../images/manufacturing_guide/IMG_20230210_131022_517.jpg)
+
+Unpack the motor driver and the connector strips and take the breadboard aside.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_131109_910.jpg)
+
+Plug the connectors with the appropriate distance to the breadboard.
+
+!!! Info
+
+    The breadboard supports you during soldering to ensure the spacing and angle of the connectors, alternatively you can also use a third hand.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_133453_815.jpg)
+
+Now position the motor driver on the connector strips of the beadboard.
+
+!!! Warning
+
+    Make sure that the larger chip labeled trimatik is positioned on the bottom of the board and the four smaller chips are positioned on the top of the board as shown in the picture.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_133632_016.jpg)
+
+Now solder all pins of the connector strip.
+
+!!! Info
+
+    Soldering is sometimes like eating with chopsticks 🥢. It takes a bit of practice, but with time you learn how to hold the workpiece in place with one free finger and apply the solder with another, and then use the other hand to move the soldering iron to the workpiece and solder it.
+
+!!! Tip
+
+    You can also solder one pin on one side and then the opposite one to fix your workpiece, this ensures that nothing accidentally moves.
+
+---
+
+#### Soldering of the motor driver sockets
+
+![](../images/manufacturing_guide/IMG_20230210_134008_727.jpg)
+
+Now take the PlanktoScope Hat board and the female connector of the stepper motor driver and position them as shown in the picture.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_134140_898.jpg)
+
+Now put the previously soldered motor driver on the socket connector to fix it for the soldering process. Turn the board as shown in the picture and place it carefully.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_134243_277.jpg)
+
+Now solder all pins of the connector strip.
+
+!!! Info
+
+    Soldering is sometimes like eating with chopsticks 🥢. It takes a bit of practice, but with time you learn how to hold the workpiece in place with one free finger and apply the solder with another, and then use the other hand to move the soldering iron to the workpiece and solder it.
+
+!!! Tip
+
+    You can also solder one pin on one side and then the opposite one to fix your workpiece, this ensures that nothing accidentally moves.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_135810_493.jpg)
+
+Repeat the procedure with the second motor driver. The end result should look like this.
+
+---
+
+#### Soldering the connection sockets
+
+![](../images/manufacturing_guide/IMG_20230210_135925_885.jpg)
+
+Now solder the motor driver sockets, inserting the connector into the holes as shown.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_140051_746.jpg)
+
+Turn the board over and hold the loose connector while soldering it. Repeat the procedure with the second motor connector.
+
+!!! Info
+
+    Soldering is sometimes like eating with chopsticks 🥢. It takes a bit of practice, but with time you learn how to hold the workpiece in place with one free finger and apply the solder with another, and then use the other hand to move the soldering iron to the workpiece and solder it.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_140238_720.jpg)
+
+Repeat the procedure with the power connector. The end result should look like this.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_140454_602.jpg)
+
+Repeat the procedure with the led connector. The end result should look like this.
+
+---
+
+#### Soldering the Raspberry Pi connector
+
+![](../images/manufacturing_guide/IMG_20230210_141753_889.jpg)
+
+Now solder the Raspberry Pi header connector with all 20 pins.
+
+!!! Warning
+
+    Be extremely careful when soldering the connections, make sure you don't accidentally bridge several contacts because you used too much solder or have cold solder joints because you had too little solder or too little heat.
+
+---
+
+#### Install and solder the cooling fan
+
+<!-- ![](../images/manufacturing_guide/xxxxxxxxxxxxxxxx.jpg) -->
+
+Install the fan with the four screws and nuts.
+
+!!! Warning
+
+    Pay attention to the running direction with the arrow marking on the side of the fan. The fan should blow on the cooler of the Raspberry Pi.
+
+---
+
+<!-- ![](../images/manufacturing_guide/xxxxxxxxxxxxxxxx.jpg) -->
+
+Cut off the excess cable of the fan and leave about 6 cm.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_144404_281.jpg)
+
+Feed the fan cable through the hole provided, check if you can reach the contacts on the board without any problems and trim it further if necessary and enisolate the ends.
+
+---
+
+![](../images/manufacturing_guide/IMG_20230210_144605_565.jpg)
+
+Solder the fan cables according to the marking and color codes ⚫ GND, 🔴 VCC, 🟡 RPM, 🔵 PWM.
+
+!!! note
+
+    If your fan doesn't have a 🔵 PWM connector, then that's not a problem, you can just leave it out.
+
+---
+
+#### Solder the display connector
+
+![](../images/manufacturing_guide/IMG_20230210_144803_799.jpg)
+
+Insert the pin headers into the holes provided, hold them in place, carefully turn the board over and solder the connector.
+
+!!! note
+
+    If you do not use an OLED display, you do not need to solder the connector.
+
+---
+
+#### Solder the configuration option jumpers
+
+<!-- ![](../images/manufacturing_guide/XXXXXXXXXXXXXXXXXXX.jpg) -->
+
+Insert the pin headers into the holes provided, hold them in place, carefully turn the board over and solder the connector.
+
+!!! note
+
+    If you do not use an OLED display, you do not need to solder the connector.
+
+---
+
+#### You have finished soldering the components
+
+![](../images/manufacturing_guide/IMG_20230210_144924_538.jpg)
+
+The assembly of the thru-hole components for the planktoscope hat is now complete. The end result should look like this.
+
+---
+
+## PlanktoScope Hard case
+
+### Hard case Requirements
+
+#### Hard case tools
+
+- double sided adhesive tape
+
+#### Hard case parts
+
+- Hard case
+
+![Case and double sided adhesive tape](../images/manufacturing_guide/IMG_20230129_163747_902.jpg)
+
+### Foam preparation
+
+![Divide foam](../images/manufacturing_guide/IMG_20230129_163501_186.jpg)
+
+Cut the foam block at the outer edge by gently tearing it apart with your fingers.
+
+!!! Warning
+
+    Be careful the foam tears easily and can not be repaired.
+
+!!! Tip
+
+    You can try in the middle of the foam block to see how the material can be cut through before you peel off with the edge.
+
+---
+
+![Foam glue](../images/manufacturing_guide/IMG_20230129_163337_964.jpg)
+
+Now lay a layer of two-sided adhesive tape on the upper inside edge of the case, with which we can later attach the show fabric.
+
+---
+
+![Insert foam](../images/manufacturing_guide/IMG_20230129_163710_699.jpg)
+
+Now insert the foam edge in to the case and glue it to the outer wall.
+
+!!! Note
+
+    Before you fix the foam, position it completely and check that it is placed flush with the edge of the case.
+
+---
+
+## Kit composition
+
+<!-- ![all kit parts](../images/manufacturing_guide/XXXXX.jpg) -->
+
+Now divide all the components for a kit and pack it in the hard case.
+
+---