rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated the readme

Browse source
This commit is contained in:
Joel Collins 2019-01-07 16:14:36 +00:00
parent 0cab5c962d
commit aa7468e960
1 changed files with 16 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -2,32 +2,36 @@ OpenFlexure Microscope Software
===================== =====================
# Installation # Installation
This module is currently in very early development, and is perhaps best installed in developer mode.
- (Recommended) create a virtual environment - (Recommended) create a virtual environment
- In the openflexure-microscope-software directory, create a venv with `python3 -m venv env` - Create a virtual environment with `python3 -m venv env` (or your favourite virtual environment system)
- Activate with `source env/bin/activate` - Activate with `source env/bin/activate`
- Install dependencies with `sudo apt-get install libatlas-base-dev libjasper-dev libjpeg-dev` - Install non-python dependencies with `sudo apt-get install libatlas-base-dev libjasper-dev libjpeg-dev`
- Install requirements with `pip install -r requirements.txt` - Install module by running `pip install openflexure-microscope==1.0.0b0`
- Install module in developer mode by running `python3 setup.py develop`
- Installing in developer mode allows the module to be modified by editing files directly in the openflexure-microscope-software directory.
# Developer usage examples
# Usage
## Running the web API in Gunicorn (port 5000) ## Running the web API in Gunicorn (port 5000)
- Ensure Gunicorn is installed to the current environment (`pip install gunicorn`) - Ensure Gunicorn is installed to the current environment (`pip install gunicorn`)
- Run `gunicorn --threads 5 --workers 1 --bind 0.0.0.0:5000 openflexure_microscope.api.app:app` - Run `gunicorn --threads 5 --workers 1 --bind 0.0.0.0:5000 openflexure_microscope.api.app:app`
- Alternatively, run `source start_interface` from the openflexure-microscope-software directory.
## Running tests through the PTVSD remote debugger (port 3000)
- From the openflexure-microscope-software directory, run `python3 -m ptvsd --host 0.0.0.0 --port 3000 --wait tests/test_camera.py`
# REST(ish) API # REST(ish) API
The Flask app serves a (reasonably) RESTful web API. For most user-facing functionality, this is the preferred interface. The Flask app serves a (reasonably) RESTful web API. For most user-facing functionality, this is the preferred interface.
API documentation, with example requests, is available [here](https://openflexure-microscope-software.readthedocs.io/en/latest/api.html). API documentation, with example requests, is available [here](https://openflexure-microscope-software.readthedocs.io/en/latest/api.html).
# Microscope plugins
# Developer notes
## Build-system
As of 1.0.0b0, we're using [Poetry](https://github.com/sdispater/poetry) to manage dependencies, build, and distribute the package. All package information and dependencies are found in `pyproject.toml`, in line with [PEP 518](https://www.python.org/dev/peps/pep-0518/). If you're developing this package, make use of `poetry.lock` to ensure you're using the latest locked dependency list.
## Microscope plugins
The Microscope module, and Flask app, both support plugins for extending lower-level functionality not well suited to web API calls. The Microscope module, and Flask app, both support plugins for extending lower-level functionality not well suited to web API calls.
This plugin system is still in fairly early development, and is not yet properly documented. The current documentation can be found [here](https://openflexure-microscope-software.readthedocs.io/en/latest/plugins.html). This plugin system is still in fairly early development, and is not yet properly documented. The current documentation can be found [here](https://openflexure-microscope-software.readthedocs.io/en/latest/plugins.html).
## Running tests through the PTVSD remote debugger (port 3000)
- From the openflexure-microscope-software directory, run `python3 -m ptvsd --host 0.0.0.0 --port 3000 --wait tests/test_camera.py`
# Credits # Credits
## Video streaming ## Video streaming
Based on supporting code for the article [video streaming with Flask](http://blog.miguelgrinberg.com/post/video-streaming-with-flask) and its follow-up [Flask Video Streaming Revisited](http://blog.miguelgrinberg.com/post/flask-video-streaming-revisited). Based on supporting code for the article [video streaming with Flask](http://blog.miguelgrinberg.com/post/video-streaming-with-flask) and its follow-up [Flask Video Streaming Revisited](http://blog.miguelgrinberg.com/post/flask-video-streaming-revisited).