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

1. Choose installation location and open a terminal there

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

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

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

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

   python -m pip install -e .
   

For Contributors

1. Be added as a contributor on the GitHub

2. Choose installation location and open a terminal there

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

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

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

   python -m pip install -e .
   

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