Merge pull request #1 from willu47/docs-will

README.md

@@ -1,6 +1,8 @@
 ##Sensitivity Analysis Library (SALib)
 
-Python implementations of commonly used sensitivity analysis methods. Useful in systems modeling to calculate the effects of model inputs or exogenous factors on outputs of interest.
+Python implementations of commonly used sensitivity analysis methods. Useful in systems modeling to calculate the effects of model inputs or exogenous factors on outputs of interest.
+
+**Documentation:** [ReadTheDocs](http://salib.readthedocs.org)
 
 **Requirements:** [NumPy](http://www.numpy.org/), [SciPy](http://www.scipy.org/), [matplotlib](http://matplotlib.org/)
 

docs/conf.py

@@ -15,6 +15,7 @@
 import sys
 import os
 import shlex
+import versioneer
 
 # Work on ReadTheDocs.org
 #on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
@@ -79,9 +80,9 @@ def __getattr__(cls, name):
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = versioneer.get_version()
 # The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = versioneer.get_version()
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/getting-started.rst

@@ -2,25 +2,12 @@
 Getting Started
 ===============
 
-Installing Prerequisite Software
---------------------------------
-
-SALib requires `NumPy <http://www.numpy.org/>`_, `SciPy <http://www.scipy.org/>`_,
-and `matplotlib <http://matplotlib.org/>`_ 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:
+To install the latest stable version of SALib using pip, together with all the 
+dependencies, run the following command:
 
 ::
 
@@ -34,12 +21,39 @@ We encourage users use the latest stable version.
 
     git clone https://github.com/SALib/SALib.git
     cd SALib
-    python setup.py install
+    python setup.py develop
+
+
+Installing Prerequisite Software
+--------------------------------
+
+SALib requires `NumPy <http://www.numpy.org/>`_, `SciPy <http://www.scipy.org/>`_,
+and `matplotlib <http://matplotlib.org/>`_ installed on your computer.  Using
+`pip <https://pip.pypa.io/en/stable/installing/>`_, these libraries can be
+installed with the following command:
+
+::
+
+    pip install numpy
+    pip install scipy
+    pip install matplotlib
+
+The packages are normally included with most Python bundles, such as Anaconda and Canopy.
+In any case, they are installed automatically when using pip or setuptools to install
+SALib.    
+
 
 Testing Installation
 --------------------
 
-To test your installation of SALib, start a new interactive Python session
+To test your installation of SALib, run the following command
+
+::
+
+    python setup.py test
+
+Alternatively, if you’d like also like a taste of what SALib provides,
+start a new interactive Python session
 and copy/paste the code below.
 
 .. code:: python