From a80fae1af5a11aafc5128f5920abc763f15d30bc Mon Sep 17 00:00:00 2001 From: thibaut pollina Date: Sun, 9 Feb 2020 00:20:14 -0800 Subject: [PATCH] update README.md --- README.md | 4 +--- flows/README.md | 1 + scripts/README.md | 32 ++++---------------------------- 3 files changed, 6 insertions(+), 31 deletions(-) create mode 100644 flows/README.md diff --git a/README.md b/README.md index 4fcf042..35cebb5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ # PlanktonScope +Please find the documentation here : https://planktonscope.readthedocs.io/en/latest/index.html - - -This is a test from Atom diff --git a/flows/README.md b/flows/README.md new file mode 100644 index 0000000..fda6daf --- /dev/null +++ b/flows/README.md @@ -0,0 +1 @@ +The files present here are Node-RED flows easily shared via this `json` format. diff --git a/scripts/README.md b/scripts/README.md index 9bd0808..609d679 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -13,14 +13,14 @@ _________________ ### Pumping ##### pump.py `volume` `flowrate` `action` -- `volume` : **integer** -- `flowrate` : **float** +- `volume` : **integer** +- `flowrate` : **float** - `action` : **string** Example: python3.7 $HOME/PlanktonScope/scripts/pump.py 1 10 suck - + _________________ ### Image ##### image.py `in_path` `sample_project` `sample_id` `acq_id` `volume` `flowrate` @@ -35,7 +35,7 @@ _________________ Example: python3.7 $HOME/PlanktonScope/scripts/image.py $HOME/PlanktonScope/Acquisitions/ tara_pacific station_125 exp_1 24 3.2 - + _________________ @@ -58,27 +58,3 @@ _________________ Example: python3.7 $HOME/PlanktonScope/scripts/fan.py on - -_________________ -### Killing Focus or Pump event -##### killer.sh `event_to_kill.py` - -- `event_to_kill.py` : **string** - - -Example: - - bash $HOME/PlanktonScope/scripts/killer.sh pump.py - -_________________ -### Kill Image -##### kill_image.sh image.py `sample_project` `sample_id` `acq_id` - -- `sample_project` : **string** -- `sample_id` : **string** -- `acq_id` : **string** - -Example: - - bash $HOME/PlanktonScope/scripts/killer.sh image.py tara_pacific station_125 exp_1 -