Getting Started
================

----------

Installing MARIGOLD is relatively simple, but it does depend if you plan to make changes. These instructions assume that you already have git installed, as well as basic terminal chops

For Users
#########

#. Choose installation location and open a terminal there

#. Clone the MARIGOLD repository from https://github.com/ajdix/MARIGOLD/

   * This can be accomplished from a web browser, or command line 

   .. code-block:: bash

    git clone https://github.com/ajdix/MARIGOLD/

#. Install MARIGOLD with pip. In the MARIGOLD directory, run the command

   .. code-block:: bash

    python -m pip install -e .


For Contributors
################

#. Be added as a contributor on the GitHub

#. Choose installation location and open a terminal there

#. Checkout the MARIGOLD repository from https://github.com/ajdix/MARIGOLD/

   .. code-block:: bash

    git checkout https://github.com/ajdix/MARIGOLD/

#. Install MARIGOLD with pip. In the MARIGOLD directory, run the command

   .. code-block:: bash

    python -m pip install -e .

To verify that it installed correctly, try running ``example_analysis.ipynb`` in your iPython interpreter of choice