update README.md

This commit is contained in:
thibaut pollina 2020-02-09 00:20:14 -08:00
parent 60bdc3ede6
commit a80fae1af5
3 changed files with 6 additions and 31 deletions

View file

@ -1,6 +1,4 @@
# PlanktonScope
Please find the documentation here :
https://planktonscope.readthedocs.io/en/latest/index.html
This is a test from Atom

1
flows/README.md Normal file
View file

@ -0,0 +1 @@
The files present here are Node-RED flows easily shared via this `json` format.

View file

@ -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