added install doc

dizcza · Nov 27, 2020 · fc851a8 · fc851a8
1 parent d027961
commit fc851a8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -7,6 +7,7 @@ PyTorch implementation of `project` and `associate` operations [1]_.
 .. toctree::
     :maxdepth: 1
 
+    install
     explanation
     usage
 

diff --git a/doc/install.rst b/doc/install.rst
@@ -0,0 +1,15 @@
+Installation
+============
+
+The source code of this project is located `here
+<https://github.com/dizcza/assemblies>`_.
+
+To install the package and reproduce the figures, run the following commands
+in a terminal:
+
+.. code-block:: sh
+
+    git clone https://github.com/dizcza/assemblies.git
+    cd assemblies
+    pip install -r requirements.txt
+    python assembly/simulate.py