From 1b8565391b35541f5c0e6ed135280045b35e354c Mon Sep 17 00:00:00 2001 From: RobertGawron Date: Wed, 11 Dec 2024 13:21:46 +0100 Subject: [PATCH] impr structure --- .gitignore | 1 - README.md | 18 +++++++++++++++--- 2 files changed, 15 insertions(+), 4 deletions(-) delete mode 100644 .gitignore diff --git a/.gitignore b/.gitignore deleted file mode 100644 index ba0430d..0000000 --- a/.gitignore +++ /dev/null @@ -1 +0,0 @@ -__pycache__/ \ No newline at end of file diff --git a/README.md b/README.md index 3ab1f87..151fe28 100755 --- a/README.md +++ b/README.md @@ -34,6 +34,11 @@ Remarks: PCB was done in KiCAD. +### Hazards + +* **The battery container electrodes for chamber polarization are very close to the metal casing; the soldered electrodes should be filed down and secured with insulating tape to prevent short circuits.** +* **The device uses relatively high voltage (32V) to polarize the ionization chamber.** The electrodes of the ionization chamber should not be touched. + ## Software * [Details about the firmware are available here.](./Software/Firmware/README.md) @@ -41,7 +46,14 @@ PCB was done in KiCAD. In the future, data from the device will be gathered and processed using the [HardwareDataLogger project](https://github.com/RobertGawron/HardwareDataLogger), which is currently in development. -## Hazards +## Simulation -* **The battery container electrodes for chamber polarization are very close to the metal casing; the soldered electrodes should be filed down and secured with insulating tape to prevent short circuits.** -* **The device uses relatively high voltage (32V) to polarize the ionization chamber.** The electrodes of the ionization chamber should not be touched. +A simple mockup was created to generate dummy test data without the need for the real device. This allows testing of the acquisition software (mainly the scripts that generate output diagrams) without requiring hardware. + +[More details.](Simulation/README.md) + +## DevOps + +All software is developed inside a Docker container. + +[More information about setting up the environment.](./DevOps/Docker/README.md) \ No newline at end of file