planktoscope/scripts/README.md

85 lines
1.8 KiB
Markdown
Raw Normal View History

2019-12-13 22:34:45 +01:00
_________________
### 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:
2019-12-13 23:20:48 +01:00
python3.7 $HOME/PlanktonScope/scripts/pump.py 1 10 suck
2019-12-13 22:34:45 +01:00
_________________
2019-12-13 23:51:50 +01:00
### Image
##### image.py `in_path` `sample_project` `sample_id` `acq_id` `volume` `flowrate`
2019-12-13 22:34:45 +01:00
2019-12-13 23:51:50 +01:00
- `in_path` : **string** - directory to store acquisitions **the path has to end with /**
- `sample_project` : **string**
- `sample_id` : **string**
- `acq_id` : **string**
- `volume` : **integer**
- `flowrate` : **float**
2019-12-13 22:34:45 +01:00
Example:
2019-12-13 23:51:50 +01:00
python3.7 $HOME/PlanktonScope/scripts/image.py $HOME/PlanktonScope/Acquisitions/ tara_pacific station_125 exp_1 24 3.2
2019-12-13 22:34:45 +01:00
2019-12-13 23:51:50 +01:00
2019-12-13 22:34:45 +01:00
_________________
2019-12-13 23:51:50 +01:00
### Light
##### light.py `state`
2019-12-14 00:09:07 +01:00
- `state` : **string** - `on` OR `off`
2019-12-13 23:51:50 +01:00
Example:
python3.7 $HOME/PlanktonScope/scripts/light.py on
2019-12-14 00:09:07 +01:00
_________________
### Fan
##### fan.py `state`
- `state` : **string** - `on` OR `off`
Example:
python3.7 $HOME/PlanktonScope/scripts/fan.py on
2019-12-13 23:51:50 +01:00
_________________
### Killing Focus or Pump event
##### killer.sh `event_to_kill.py`
- `event_to_kill.py` : **string**
2019-12-13 22:34:45 +01:00
Example:
2019-12-13 23:51:50 +01:00
bash $HOME/PlanktonScope/scripts/killer.sh pump.py
2019-12-13 22:34:45 +01:00
_________________
### Kill Image
##### kill_image.sh image.py `sample_project` `sample_id` `acq_id`
- `sample_project` : **string**
- `sample_id` : **string**
- `acq_id` : **string**
Example:
2019-12-13 23:12:56 +01:00
bash $HOME/PlanktonScope/scripts/killer.sh image.py tara_pacific station_125 exp_1
2019-12-13 22:34:45 +01:00