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

Created very basic quickstart

Browse source
This commit is contained in:
Joel Collins 2019-01-07 16:53:11 +00:00
parent c8b7249bd9
commit eb181fcaa5
1 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/source/quickstart.rst
View file

@ -1,8 +1,19 @@
Quickstart
=======================================================
Install
-------
- (Recommended) create a virtual environment
- Create a virtual environment with ``python3 -m venv env`` (or your favourite virtual environment system)
- Activate with ``source env/bin/activate``
- Install non-python dependencies with ``sudo apt-get install libatlas-base-dev libjasper-dev libjpeg-dev``
- Install module by running ``pip install openflexure-microscope==1.0.0b0``
Web API
-------
Python
------
Simple development server with 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``