update README.md
This commit is contained in:
parent
60bdc3ede6
commit
a80fae1af5
|
@ -1,6 +1,4 @@
|
||||||
# PlanktonScope
|
# PlanktonScope
|
||||||
|
|
||||||
|
Please find the documentation here :
|
||||||
https://planktonscope.readthedocs.io/en/latest/index.html
|
https://planktonscope.readthedocs.io/en/latest/index.html
|
||||||
|
|
||||||
|
|
||||||
This is a test from Atom
|
|
||||||
|
|
1
flows/README.md
Normal file
1
flows/README.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
The files present here are Node-RED flows easily shared via this `json` format.
|
|
@ -13,14 +13,14 @@ _________________
|
||||||
### Pumping
|
### Pumping
|
||||||
##### pump.py `volume` `flowrate` `action`
|
##### pump.py `volume` `flowrate` `action`
|
||||||
|
|
||||||
- `volume` : **integer**
|
- `volume` : **integer**
|
||||||
- `flowrate` : **float**
|
- `flowrate` : **float**
|
||||||
- `action` : **string**
|
- `action` : **string**
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
python3.7 $HOME/PlanktonScope/scripts/pump.py 1 10 suck
|
python3.7 $HOME/PlanktonScope/scripts/pump.py 1 10 suck
|
||||||
|
|
||||||
_________________
|
_________________
|
||||||
### Image
|
### Image
|
||||||
##### image.py `in_path` `sample_project` `sample_id` `acq_id` `volume` `flowrate`
|
##### image.py `in_path` `sample_project` `sample_id` `acq_id` `volume` `flowrate`
|
||||||
|
@ -35,7 +35,7 @@ _________________
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
python3.7 $HOME/PlanktonScope/scripts/image.py $HOME/PlanktonScope/Acquisitions/ tara_pacific station_125 exp_1 24 3.2
|
python3.7 $HOME/PlanktonScope/scripts/image.py $HOME/PlanktonScope/Acquisitions/ tara_pacific station_125 exp_1 24 3.2
|
||||||
|
|
||||||
|
|
||||||
_________________
|
_________________
|
||||||
|
|
||||||
|
@ -58,27 +58,3 @@ _________________
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
python3.7 $HOME/PlanktonScope/scripts/fan.py on
|
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
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue