v0.5.1,add spidev to requirements, readme updates

gutow · Mar 9, 2023 · 51d8b3a · 51d8b3a
1 parent 21fc728
commit 51d8b3a
Show file tree

Hide file tree

Showing 14 changed files with 2,996 additions and 2,984 deletions.
diff --git a/README.md b/README.md
@@ -111,6 +111,9 @@ install as a special kernel when you are the user.
      found [here](https://janakiev.com/til/jupyter-virtual-envs/). 
 
 ## Change Log
+* 0.5.1 (Mar. 9, 2023) 
+  * Include `spidev` package in requirements. 
+  * More details reported when unable to "find trough".
 * 0.5.0 (Mar. 4, 2023) First version with working GUI
 * 0.1.0 First pypi compatible package version.
 
@@ -134,9 +137,8 @@ install as a special kernel when you are the user.
 2. Update any `.md` files included in `_init_.py`.
    * Generally URLs should be absolute, not relative.
 3. At the root level run pdoc `pdoc --logo-link https://gutow.github.
-   io/Langmuir_Trough/ --footer-text "Langmuir_Trough vX.X.X" --math -html -o 
-   docs Trough_GUI Trough_Control` 
-   where `X.X.X` is the version number.
+io/Langmuir_Trough/ --footer-text "Langmuir_Trough vX.X.X" --math -html -o 
+docs Trough_GUI Trough_Control` where `X.X.X` is the version number.
 4. Because of the way the document building process works the background tasks 
    will be started. **You will have to stop the document build after the 
    documentation is done building (watch the `doc` folder) with a `^C` to 

diff --git a/Trough_Control/trough_util.py b/Trough_Control/trough_util.py
@@ -99,6 +99,8 @@ def init_trough():
         from piplates import DAQC2plate
         del DAQC2plate
     except Exception as e:
+        print("An issue was encountered while accessing the DAQC2plate:" +
+              str(e))
         trough_exists = False
     if trough_exists:
         TROUGH = Process(target=troughctl, args=(cmdrcv, datasend))

diff --git a/docs/Trough_Control.html b/docs/Trough_Control.html
@@ -63,7 +63,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/docs/Trough_Control/message_utils.html b/docs/Trough_Control/message_utils.html
@@ -58,7 +58,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/docs/Trough_Control/simulation.html b/docs/Trough_Control/simulation.html
@@ -58,7 +58,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/docs/Trough_Control/trough_util.html b/docs/Trough_Control/trough_util.html
diff --git a/docs/Trough_GUI.html b/docs/Trough_GUI.html
@@ -66,7 +66,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/docs/Trough_GUI/Collect_data.html b/docs/Trough_GUI/Collect_data.html
diff --git a/docs/Trough_GUI/Monitor_Calibrate.html b/docs/Trough_GUI/Monitor_Calibrate.html
@@ -58,7 +58,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/docs/Trough_GUI/calibration_utils.html b/docs/Trough_GUI/calibration_utils.html
@@ -91,7 +91,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/docs/Trough_GUI/command_widgets.html b/docs/Trough_GUI/command_widgets.html
@@ -70,7 +70,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/docs/Trough_GUI/conversions.html b/docs/Trough_GUI/conversions.html
@@ -73,7 +73,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/docs/Trough_GUI/status_widgets.html b/docs/Trough_GUI/status_widgets.html
@@ -67,7 +67,7 @@ <h2>API Documentation</h2>
     </ul>
 
 
-            <footer>Langmuir_Trough v0.5.0</footer>
+            <footer>Langmuir_Trough v0.5.1</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img

diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="langmuir_trough",
-    version="0.5.0",
+    version="0.5.1",
     description="Controls and collects data from Gutow Lab Langmuir Trough.",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -23,7 +23,8 @@
         'JPSLMenus>=0.5.0',
         'lmfit>=1.0.3',
         'round-using-error>=1.1.1',
-        'RPi.GPIO>=0.7.0;platform_system=="Linux"',
+        'RPi.GPIO>=0.7.0;platform_system=="Linux"', # pi-plates requires
+        'spidev>=3.5;platform_system=="Linux"', # pi-plates requires
         'pi-plates>=7.21',
         'numpy>=1.21',
         'plotly>=5.8.2',