Developed index.rst and the installation guide.

tmcclintock · Nov 15, 2017 · 74003fd · 74003fd
1 parent 283c3f7
commit 74003fd
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 4 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,14 +1,19 @@
-Cluster Toolkit Documentation!
-======================================
+******************************
+Cluster Toolkit Documentation
+******************************
 
 Cluster Toolkit is a Python package specifically built for calculating weak lensing signals from galaxy clusters and cluster cosmology.
 The core functionality of the package includes:
 
  * 3D correlation functions :math:`\xi(r)`
  * 3D density functions :math:`\rho(r)`
+ * Halo bias models :math:`b(M)`
  * Projected density and differential profiles :math:`\Sigma(R)` and :math:`\Delta\Sigma`
  * Boost factor models :math:`\mathcal{B} = (1-f_{\rm cl})^{-1}`
  * Miscentering affects on projected profiles :math:`f_{\rm mis}`
+ * Halo mass functions :math:`\frac{dn}{dM}(M,z)` (in development)
+ * Sunyaev-Zel'dovich (SZ) cluster signals :math:`Y_{SZ}` (in development)
+ * Cluster magnification :math:`\kappa(\theta)` and shear profiles :math:`\gamma(\theta)` (in development)
 
 The source code is publically available at https://github.com/tmcclintock/cluster_toolkit.
 

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,5 +1,19 @@
-============
+************************
 Installation
+************************
+
+To install the cluster_toolkit you currently need to build it from source::
+  
+  git clone https://github.com/tmcclintock/cluster_toolkit.git
+  cd cluster_toolkit
+  python setup.py install
+
+Requirements
 ============
+This package has only ever been tested with Python 2.7.x and has some dependencies. The Python dependencies that you can get with pip are:
+
+- `Numpy <http://www.numpy.org/>`_: 1.13 or later
+
+- `cffi <https://cffi.readthedocs.io/en/latest/>`_: 1.10 or later
 
-Still working on this!
+In addition, you must have the `GNU Science Library <https://www.gnu.org/software/gsl/>`_ (GSL) installed. If you follow the instructions in their INSTALL file you will be done in only a few lines in the terminal. There is a pip installable GSL, but I do not know if it will work with the cluster toolkit.