From eb181fcaa56c1cfdac86cf6585e0a580ddc8d4ed Mon Sep 17 00:00:00 2001 From: Joel Collins Date: Mon, 7 Jan 2019 16:53:11 +0000 Subject: [PATCH] Created very basic quickstart --- docs/source/quickstart.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 4bb44875..7e32702e 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -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 ------- \ No newline at end of file +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`` \ No newline at end of file