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

Updated documentation for installation

Browse source
This commit is contained in:
Joel Collins 2019-03-19 16:59:29 +00:00
parent d445b359e9
commit 8a12d89ffc
1 changed files with 20 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/source/quickstart.rst
View file

@ -4,21 +4,36 @@ Quickstart
Install Install
------- -------
Auto-installer Quick-installer
++++++++++++++ +++++++++++++++
For most users, this is the reccommended installation method.
- Run ``curl -LSs get.openflexure.org/microscope |sudo bash`` - Run ``curl -LSs get.openflexure.org/microscope |sudo bash``
- See the `GitLab repo <https://gitlab.com/openflexure/openflexure-microscope-installer>`_ for details. - See the `GitLab repo <https://gitlab.com/openflexure/openflexure-microscope-installer>`_ for details.
- Follow on-screen prompts - Follow on-screen prompts
Manual Really-quick installer
++++++ ^^^^^^^^^^^^^^^^^^^^^^
The installer script can run with all default settings applied, removing all user prompts.
- Run ``curl -LSs get.openflexure.org/microscope |sudo bash -s -- -y``
Developer installer
^^^^^^^^^^^^^^^^^^^
The installer script can pull the latest development package from our git repository, and use install into a developer environment using Poetry.
- Run ``curl -LSs get.openflexure.org/microscope |sudo bash -s -- -d``
Manual installation
+++++++++++++++++++
- (Recommended) create a virtual environment - (Recommended) create a virtual environment
- ``pip3 install virtualenv`` - ``pip3 install virtualenv``
- ``mkdir ~/.openflexure`` - ``mkdir ~/.openflexure``
- ``python3 -m virtualenv ~/.openflexure/envmicroscope`` - ``python3 -m virtualenv ~/.openflexure/envmicroscope``
- Activate with ``source /.openflexure/envmicroscope/bin/activate`` - Activate with ``source /.openflexure/envmicroscope/bin/activate``
- Install non-python 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``
- **Users:** Install module by running ``pip install openflexure-microscope==1.0.0b7`` - **Users:** Install module by running ``pip install openflexure-microscope``
- **Developers:** Install `Poetry <https://github.com/sdispater/poetry>`_, clone this repo, and ``poetry install`` from inside the repo. - **Developers:** Install `Poetry <https://github.com/sdispater/poetry>`_, clone this repo, and ``poetry install`` from inside the repo.
API Server API Server