#######################################
Welcome to SwiftPhotom's documentation!
#######################################

The module level docstrings attempt to follow the following format : `Google Style Sphinx <http://www.sphinx-doc.org/en/master/ext/example_google.html>`_

Installing SwiftPhotom
======================

It is highly suggested (but not formally necessary) to first create and activate a separate new virtual environment. 

The easiest method to install SwiftPhotom is using `pip <https://pip.pypa.io/en/stable/>`_ directly from the `GitHub repository <https://github.com/gterreran/Swift_host_subtraction.git>`_:

.. code-block:: bash

   $ pip install git+https://github.com/gterreran/Swift_host_subtraction.git

Alternatively, after cloning this repository, from the main folder simply run

.. code-block:: bash

   $ python setup.py install

For more details see :ref:`install`.

Package documentation
---------------------

Please consult these pages for more details on using GravitySpy:

.. toctree::
   :maxdepth: 1

   inputs/index
   extraction/index

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`