documentation

README.md

@@ -15,7 +15,7 @@ Dependencies
 * [PyDAQmx](https://pythonhosted.org/PyDAQmx/installation.html)
 * The GUI application (`forceDAQ.gui`) depends furthermore on [Expyriment](http://docs.expyriment.org/Installation.html) 0.8.0 or higher
 
-Recommended for GUI interface:
+Stringly recommended for GUI interface:
 * [PySimpleGUI](https://pysimplegui.readthedocs.io/)
 
 Installation
@@ -24,7 +24,19 @@ Installation
 * Create the shared library `atidaq.dll` (or `atidaq.so` for Linux) using
  `Makefile` in the folder `atidaq_cdll`. A complied version of `atidaq.dll
  ` can be also found in the `dll` subfolder
-* Make the library available by coping it in your system folder 
+* Make the library available by coping it in your system folder
+
+To install pyForceDAQ from release-zipfile
+
+1. Ensure that [Python 3](https://www.python.org/) is installed
+2. Download and unpack zip file
+3. run `install_dependencies.py`
+4. run `forceDAQ_GUI.py`
+5. edit settings via GUI if required
+
+**Note:** The software uses per default a DummySensor and simulates data. For the use of force sensors in the lab, please change `forceDAQ.py` accordingly.
+
+``forceDAQ.USE_DUMMY_SENSOR = False``
 
 Development
 -----------

forceDAQ_GUI.py

@@ -1,19 +1,18 @@
 __author__ = 'Oliver Lindemann'
+
 import forceDAQ
-forceDAQ.USE_DUMMY_SENSOR = True
-TRY_TK_LAUNCHER = True
+forceDAQ.USE_DUMMY_SENSOR = True # <-- change for usage in lab to False
 
 if __name__ == "__main__": # required because of threading
     from forceDAQ.gui import run
 
     tk_launcher = None
-    if TRY_TK_LAUNCHER:
-        try:
-            from forceDAQ.gui import tk_launcher
-        except:
-            print("Warning: Install PySimpleGUI to use tk_launcher GUI.")
+    try:
+        from forceDAQ.gui import tk_launcher
+    except:
+        print("Warning: Install PySimpleGUI to use tk_launcher GUI.")
 
     if tk_launcher is not None:
         tk_launcher.run()
     else:
-        run()
+        run()