From 0652cb95ca2ac24fcd321a2ee4e6e89ea9c96dd5 Mon Sep 17 00:00:00 2001
From: tpollina <thibaut.pollina@gmail.com>
Date: Fri, 13 Dec 2019 13:34:45 -0800
Subject: [PATCH] Create README.md

---
 scripts/README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 scripts/README.md

diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 0000000..d9219ea
--- /dev/null
+++ b/scripts/README.md
@@ -0,0 +1,70 @@
+_________________
+### Focusing
+##### focus.py `nb_step` `orientation`
+
+- `nb_step` : **integer** (from 1 to 100000) - number of step to perform by the stage (about 31um/step)
+- `orientation` : **string** - orientation of the focus either `up` or `down`
+
+Example:
+
+    python3.7 $HOME/PlanktonScope/scripts/focus.py 650 up
+
+_________________
+### Pumping
+##### pump.py `volume` `flowrate` `action`
+
+- `volume` : **integer** 
+- `flowrate` : **float** 
+- `action` : **string**
+
+Example:
+
+    python3.7 $HOME/PlanktonScope/scripts/pump.py 24 3.2 suck
+    
+_________________
+### Killing Focus or Pump event
+##### killer.sh `event_to_kill.py`
+
+- `event_to_kill.py` : **string**
+
+
+Example:
+
+    bash killer.sh pump.py
+    
+_________________
+### Image
+##### image.py `sample_project` `sample_id` `acq_id` `volume` `flowrate`
+
+-`sample_project` : **string**
+- `sample_id` : **string**
+- `acq_id` : **string**
+- `volume` : **integer**
+- `flowrate` : **float**
+
+Example:
+
+    python3.7 pump.py tara_pacific station_125 exp_1 24 3.2
+    
+_________________
+### Kill Image
+##### kill_image.sh image.py `sample_project` `sample_id` `acq_id`
+
+- `sample_project` : **string**
+- `sample_id` : **string**
+- `acq_id` : **string**
+
+Example:
+
+    bash killer.sh image.py tara_pacific station_125 exp_1
+    
+_________________
+
+### Light
+##### light.py `state`
+
+- `state` : **string**
+
+Example:
+
+    python3.7 light.py on