commit of the actual code previously developed

DriftCorrector.py

+import src.UI as UI
+
+def create_socket_or_die():
+    '''Create a socket to prevent multiple instances of this program'''
+    import socket
+
+    HOST = 'localhost'
+    PORT = 44528
+    s = socket.socket()
+
+    try:
+        s.bind((HOST, PORT))
+    except OSError:
+        # Program is already running
+        exit()
+
+    return s
+
+if __name__ == '__main__':
+    s = create_socket_or_die()
+    app = UI.VesicleAnnotationInterface()
+    s.close()

DriftCorrector.spec

+# -*- mode: python -*-
+
+block_cipher = None
+
+
+a = Analysis(['DriftCorrector.py'],
+             pathex=['/home/dith/arngorf/code/drift_corrector'],
+             binaries=[],
+             datas=[],
+             hiddenimports=[],
+             hookspath=['.'],
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher,
+             noarchive=False)
+pyz = PYZ(a.pure, a.zipped_data,
+             cipher=block_cipher)
+exe = EXE(pyz,
+          a.scripts,
+          [],
+          exclude_binaries=True,
+          name='DriftCorrector',
+          debug=False,
+          bootloader_ignore_signals=False,
+          strip=False,
+          upx=True,
+          console=True )
+coll = COLLECT(exe,
+               a.binaries,
+               a.zipfiles,
+               a.datas,
+               strip=False,
+               upx=True,
+               name='DriftCorrector')

README.md

@@ -14,3 +14,27 @@ This project contains a small program with user interface implementing the drift
   publisher={Nature Publishing Group}
 }
 ```
+
+# How to use
+
+1) $python DriftCorrector.py
+
+2) Click "Open dataset" to get startet
+
+3) navigate to the directory with your volume data as either a multipage tiff file or in the a number of consecutively named image files. I.e. my_image_0.png, my_image_1.png, my_image_2.png, ...
+
+4) Confirm that the tool is in "Add Points" mode in the left pane
+
+5) Annotate vesicles one at a time by using the following commands
+
+ Right-click to center at a vesicle
+ Zoom in/out using the buttons in the left pane
+ Left-click a vesicle boundary to annotate a point
+ Use the mouse scroll button or the "+" and "-" key to cycle through the image sections
+ Change viewing direction by clicking "a"
+ Undo point placement by clicking "ctrl+z"
+
+6) Click "Edit Points" to edit or delete previously placed points, do:
+
+ Right-click a previous annotation to make it active
+ Left-click a point to delete it
\ No newline at end of file