Merge pull request #236 from rbiswas4/issue232/add_docs

Fixed typos, and rebuilt

Author: rbiswas4

README.md

@@ -3,20 +3,13 @@
 Tools for summarizing the LSST Operations Simulations outputs for use with catalog simulation tools or other analyses. 
 
 [![Build Status](https://travis-ci.org/rbiswas4/OpSimSummary.svg?branch=master)](https://travis-ci.org/rbiswas4/OpSimSummary)
-- documentation is hosted at [github_pages](https://rbiswas4.github.io/OpSimSummary)
+- documentation is hosted at [github_pages](https://rbiswas4.github.io/OpSimSummary/build/html/index.html)
 
 # Installation 
-`opsimsummary` runs on either python 2.7 or 3.5+ . The list of required software to run `opsimsummary` is listed [here](./install/requirements.md). Assuming miniconda is already installed, `opsimsummary` can be installedalong with its dependencies for the current user by 
-```
-./install/install_all.sh
-```
-and it will install dependencies from conda channels or use pip.
-If the dependecies [listed](./install/requirements.md) are already installed, `opsimsummary` can be installed by running 
-```
-./install/install_opsimsummary.sh
-```
-
-Obviously, running the commands in the scripts will also allow the user to achieve the same results.
+`opsimsummary` runs on either python 2.7 or 3.5+ . The list of required software to run `opsimsummary` is listed [here](./install/requirements.md). For installation, go to 
+ the [documentation](https://rbiswas4.github.io/OpSimSummary/build/html/Installation.html)
 
 # Running
-- open the `examples/Demo_OpSimOutput.ipynb` and execute the cells.
+- `example/Demo_OpSimOutput.ipynb` 
+- `example/Demo_SynOpSim.ipynb`
+

docs/build/html/Installation.html

@@ -147,22 +147,20 @@
 
   <div class="section" id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
-<p>The engine of <cite>OpSimSummary</cite> depends on commonly used python packages. Currently, all of the
-requirements can be installed with <cite>anaconda</cite> and <cite>pip</cite>. To use <cite>OpSimSummary</cite> as a library or
-the scripts in <cite>OpSimSummary</cite>, you will need the requirements listed <a class="reference external" href="https://github.com/rbiswas4/OpSimSummary/blob/fix_release_help/install/requirements.md">here</a> .</p>
+<p>The engine of <code class="docutils literal notranslate"><span class="pre">OpSimSummary</span></code> depends on commonly used python packages. Currently, all of the
+requirements can be installed with <cite>anaconda</cite> and <cite>pip</cite>. To use <code class="docutils literal notranslate"><span class="pre">OpSimSummary</span></code> as a library or
+the scripts in <code class="docutils literal notranslate"><span class="pre">OpSimSummary</span></code>, you will need the requirements listed <a class="reference external" href="https://github.com/rbiswas4/OpSimSummary/blob/fix_release_help/install/requirements.md">here</a> .</p>
 </div>
 <div class="section" id="installing-dependencies">
 <h1>Installing Dependencies<a class="headerlink" href="#installing-dependencies" title="Permalink to this headline">¶</a></h1>
-<p>There are scripts in the <cite>./install</cite> directory which can be used to install the dependencies. To use these, you must have a conda python
-installation. If you don’t have a such a python installation, you can use a <a href="#id1"><span class="problematic" id="id2">script_</span></a>
-.. _script: <a class="reference external" href="https://github.com/rbiswas4/install_utils/tree/master/scripts">https://github.com/rbiswas4/install_utils/tree/master/scripts</a>
-to install a miniconda distribution.</p>
-<p>To install the dependenencies and <cite>OpSimSummary</cite>, from the root level of the package:</p>
+<p>There are scripts in the <code class="docutils literal notranslate"><span class="pre">./install</span></code> directory which can be used to install the dependencies. To use these, you must have a conda python
+installation. If you don’t have a such a python installation, you can use a <a class="reference external" href="https://github.com/rbiswas4/install_utils/tree/master/scripts">script</a> to install a miniconda distribution.</p>
+<p>To install the dependenencies and <code class="docutils literal notranslate"><span class="pre">OpSimSummary</span></code>, from the root level of the package:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span>bash ./install/install_all.sh
 </pre></div>
 </div>
-<p>installs the dependencies and <cite>OpSimSummary</cite>.</p>
-<p>To just install <cite>OpSimSummary</cite> if you already have taken care of the requirements, use :</p>
+<p>installs the dependencies and <code class="docutils literal notranslate"><span class="pre">OpSimSummary</span></code>.</p>
+<p>To just install <code class="docutils literal notranslate"><span class="pre">OpSimSummary</span></code> if you already have taken care of the requirements, use :</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span>bash install/install_opsimsummary
 </pre></div>
 </div>

docs/build/html/_sources/Installation.rst.txt

@@ -1,28 +1,28 @@
 Installation
 ============
 
-The engine of `OpSimSummary` depends on commonly used python packages. Currently, all of the
-requirements can be installed with `anaconda` and `pip`. To use `OpSimSummary` as a library or
-the scripts in `OpSimSummary`, you will need the requirements listed here_ .
+The engine of ``OpSimSummary`` depends on commonly used python packages. Currently, all of the
+requirements can be installed with `anaconda` and `pip`. To use ``OpSimSummary`` as a library or
+the scripts in ``OpSimSummary``, you will need the requirements listed here_ .
 
 .. _here: https://github.com/rbiswas4/OpSimSummary/blob/fix_release_help/install/requirements.md
 
 Installing Dependencies
 ========================
-There are scripts in the `./install` directory which can be used to install the dependencies. To use these, you must have a conda python
-installation. If you don't have a such a python installation, you can use a script_
+There are scripts in the ``./install`` directory which can be used to install the dependencies. To use these, you must have a conda python
+installation. If you don't have a such a python installation, you can use a script_ to install a miniconda distribution. 
+
 .. _script: https://github.com/rbiswas4/install_utils/tree/master/scripts
-to install a miniconda distribution. 
 
-To install the dependenencies and `OpSimSummary`, from the root level of the package:
+To install the dependenencies and ``OpSimSummary``, from the root level of the package:
 
 .. code-block:: console
 
    $bash ./install/install_all.sh
 
-installs the dependencies and `OpSimSummary`.
+installs the dependencies and ``OpSimSummary``.
 
-To just install `OpSimSummary` if you already have taken care of the requirements, use :
+To just install ``OpSimSummary`` if you already have taken care of the requirements, use :
 
 .. code-block:: console 
 

docs/build/html/objects.inv

@@ -2,6 +2,4 @@
 # Project: OpSimSummary
 # Version: 0.8.5
 # The remainder of this file is compressed using zlib.
-x�m�=R1�{�B�fH���b&�Hmv�g���������$x�,13t��'=Iq`�y�ޤ��i�c?:�=n��C��V}GZ�8��>v�W���ސ:�&p6Ιlc��Z�>��6��8sμ���
-�̡�b�q����H�����{�?��
-=z�|��Q��I/��,o�xB:Y���&�撩��hfC��Z��'�X���5�0�;��N4ik��5{��[��
+x�m���0��>�]ktesd0�+�Ф�B��k�z>���b�v����rg���7Z���E��B��!��U�jM�o����ET�������5�Yl|J� �Y�KN�8+�HS�}����̙�%�jӸ�qF�[�,$.�:�}^����n4�0ƮX�͟@��A�t��-֭��2}f�'Ӌyu^�'FbF�T���f\��

docs/build/html/searchindex.js

@@ -1,28 +1,28 @@
 Installation
 ============
 
-The engine of `OpSimSummary` depends on commonly used python packages. Currently, all of the
-requirements can be installed with `anaconda` and `pip`. To use `OpSimSummary` as a library or
-the scripts in `OpSimSummary`, you will need the requirements listed here_ .
+The engine of ``OpSimSummary`` depends on commonly used python packages. Currently, all of the
+requirements can be installed with `anaconda` and `pip`. To use ``OpSimSummary`` as a library or
+the scripts in ``OpSimSummary``, you will need the requirements listed here_ .
 
 .. _here: https://github.com/rbiswas4/OpSimSummary/blob/fix_release_help/install/requirements.md
 
 Installing Dependencies
 ========================
-There are scripts in the `./install` directory which can be used to install the dependencies. To use these, you must have a conda python
+There are scripts in the ``./install`` directory which can be used to install the dependencies. To use these, you must have a conda python
 installation. If you don't have a such a python installation, you can use a script_ to install a miniconda distribution. 
 
 .. _script: https://github.com/rbiswas4/install_utils/tree/master/scripts
 
-To install the dependenencies and `OpSimSummary`, from the root level of the package:
+To install the dependenencies and ``OpSimSummary``, from the root level of the package:
 
 .. code-block:: console
 
    $bash ./install/install_all.sh
 
-installs the dependencies and `OpSimSummary`.
+installs the dependencies and ``OpSimSummary``.
 
-To just install `OpSimSummary` if you already have taken care of the requirements, use :
+To just install ``OpSimSummary`` if you already have taken care of the requirements, use :
 
 .. code-block:: console