Lepton Module
=============

The Lepton module is part of the `MUSES <https://musesframework.io/>`_ framework, and it is designed to be used with an input configuration file (the `config.yaml  <https://gitlab.com/nsf-muses/module-cmf/lepton-module/-/blob/main/input/config.yaml?ref_type=heads>`_). 

The code provides the thermodynamic functions of strongly degenerate relativistic free leptons at zero temperature and allows either:

- Calculating the beta-equilibrium Equation of State (EoS)
- Neutralizing a nuclear model by adding leptons
- Calculating a purely leptonic EoS

The first two options are available if a grid EoS is provided with sufficient points in the baryon density and charge fraction. 
The purely leptonic EoS is required to calculate the Gibbs phase transition in the `Synthesis module <https://gitlab.com/nsf-muses/eos-synthesis>`_.
The code is a header only library, so it can be easily integrated into other projects.

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

   _contents/quickstart.rst
   _contents/physics.rst

   Input <_contents/input/index.rst>
   Output <_contents/output/index.rst>


More information about the module input and output can be found in the `OpenAPI Specifications <https://gitlab.com/nsf-muses/module-cmf/lepton-module/-/blob/main/api/OpenAPI_Specifications_lepton.yaml?ref_type=heads>`_.

Changes from past versions can be found in the `CHANGELOG <https://gitlab.com/nsf-muses/module-cmf/lepton-module/-/blob/main/CHANGELOG.md?ref_type=heads>`_.