Installation procedure

docs/install.rst

@@ -0,0 +1,91 @@
+Requirements and Installation
+=============================
+
+Requirements
+------------
+
+Software
+^^^^^^^^
+- Python 2.7.10+
+- pyenv
+- pyenv virtualenv
+- pip
+
+Python Modules
+^^^^^^^^^^^^^^
+- h5py
+- NumPy
+- Flask
+- Flask-Restful
+- json
+- pytest
+- Waitress
+- Sphinx
+- sphinx-autobuild
+
+Installation
+------------
+
+Basics
+^^^^^^
+Directly from GitHub:
+
+.. code-block:: none
+   :linenos:
+
+   git clone https://github.com/Multiscale-Genomics/mg-rest-3d.git
+   cd mg-rest-3d/
+   pip install -e .
+   pip install -r requirements.txt
+
+Using pip:
+
+.. code-block:: none
+   :linenos:
+
+   pip install git+https://github.com/Multiscale-Genomics/mg-rest-3d.git
+
+
+Setting up a server
+^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: none
+   :linenos:
+   
+   git clone https://github.com/Multiscale-Genomics/mg-rest-3d.git
+
+   cd mg-rest-3d
+   pyenv virtualenv 2.7.12 mg-rest-3d
+   pyenv activate mg-rest-service
+   pip install git+https://github.com/Multiscale-Genomics/mg-dm-api.git
+   pip install -e .
+   pip install -r requirements.txt
+   pyenv deactivate
+
+Starting the service:
+
+.. code-block:: none
+   :linenos:
+
+   nohup ${PATH_2_PYENV}/versions/2.7.12/envs/mg-rest-3d/bin/waitress-serve --listen=127.0.0.1:5002 rest.app:app &
+
+Testing
+---------
+Test scripts are located in the `test/` directory. Run `pytest` to from the root
+repository directory to ensure that the API is working correctly.
+
+The scripts require a valid hdf5 file generated using the scripts from
+mg-storage-hdf5 and a matching datasets.json file located in the `rest/`
+directory
+
+Documentation
+-------------
+To build the documentation:
+
+.. code-block:: none
+   :linenos:
+
+   pip install Sphinx
+   pip install sphinx-autobuild
+   cd docs
+   make html