Adds installation instructions

SALib · Sep 16, 2015 · 69997be · 69997be
1 parent 3fdcfe9
commit 69997be
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 0 deletions.
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
@@ -0,0 +1,35 @@
+===============
+Getting Started
+===============
+
+Installing Prerequisite Software
+--------------------------------
+
+SALib requires `NumPy <http://www.numpy.org/>`_, `SciPy <http://www.scipy.org/>`_,
+and `matplotlob <http://matplotlib.org/>`_ be installed on your computer.  Using
+`pip <https://pip.pypa.io/en/stable/installing/>`_, these libraries can be
+installed with:
+
+::
+    pip install numpy
+    pip install scipy
+    pip install matplotlib
+    
+Installing SALib
+----------------
+
+To install the latest stable version of SALib using pip, run the following
+command:
+
+::
+    pip install SALib
+    
+To install the latest development version of SALib, run the following
+commands:
+
+::
+    git clone https://github.com/SALib/SALib.git
+    cd SALib
+    python setup.py install
+    
+    
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,12 @@ Python implementations of commonly used sensitivity analysis methods, including
 Sobol, Morris, and FAST methods. Useful in systems modeling to calculate the
 effects of model inputs or exogenous factors on outputs of interest.
 
+.. toctree::
+   :maxdepth: 2
+
+   getting-started
+
+
 Supported Methods
 -----------------
 * Sobol Sensitivity Analysis ([`Sobol 2001 <http://www.sciencedirect.com/science/article/pii/S0378475400002706>`_], [`Saltelli 2002 <http://www.sciencedirect.com/science/article/pii/S0010465502002801>`_], [`Saltelli et al. 2010 <http://www.sciencedirect.com/science/article/pii/S0010465509003087>`_])