.. wsssss documentation master file, created by
   sphinx-quickstart on Wed Oct 30 16:13:21 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

wsssss documentation
====================

``wsssss`` is a package which make creating, running, and studying grids of stars with `MESA <https://docs.mesastar.org>`_
quick (except for the compute time) and easy.

Install with
``pip install wsssss``

``inlists.create_grid`` and ``mesa-go`` require a version of `MESA <https://docs.mesastar.org>`_ to be installed.
``gyre-driver`` requires a version of `gyre <https://gyre.readthedocs.io/en/stable/>`_ to be installed.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   API reference <modules>
   CLI reference <cmd>

.. toctree::
   :maxdepth: 1
   :caption: Examples:

   examples/examples