Installation
============

The ``persephone`` module is currently only available through
`PyPI <https://pypi.org/project/star-persephone/>`__ 
or its `GitLab repository <https://gitlab.com/sybreton/persephone>`__. 

Installation from PyPI
#######################

Simply run::

  $ pip install star-persephone

Installation from source
##########################

First, clone the online repository::

  $ git clone https://gitlab.com/sybreton/persephone.git

then go to the local repository and simply do::

  $ pip install .

In the future, it is planned to provide packaged versions of the module
through `conda-forge <https://conda-forge.org/>`__.

Installing MESA and GYRE
#########################

Most of the abilities of ``persephone`` relies on a working installation
of the MESA and GYRE codes. You will find installation instructions for
MESA `here <https://docs.mesastar.org/en/stable/installation.html>`__, 
and installation instructions for GYRE
`here <https://gyre.readthedocs.io/en/stable/user-guide/quick-start.html>`__.
In principle, ``persephone`` should work with any MESA version more
recent than ``r15140`` (including this release).