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

The ``persephone`` module is currently only available through
`PyPI <https://pypi.org/project/star-persephone/0.1/>`__ 
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/release-r23.05.1/installation.html>`__, 
and installation instructions for GYRE
`here <https://gyre.readthedocs.io/en/stable/user-guide/quick-start.html>`__.

.. note::

  Concerning the Python modules necessary for ``persephone`` to run, 
  note that for `py\_mesa\_reader <https://github.com/wmwolf/py_mesa_reader>`__, 
  you will have to clone the repository
  and install it manually from sources with ``pip``.