.. _sec_pymule_full:

pymule reference guide
======================

This section describes all functions and classes in pymule.
Most users will not have to view this.

Working with errors
-------------------

.. automodule:: pymule.errortools
   :members:

Working with abstract records
-----------------------------

.. automodule:: pymule.record
   :members:

Working with vegas records
-----------------------------

.. automodule:: pymule.vegas
   :members:

Working with records of data
----------------------------

.. automodule:: pymule.loader
   :members:

Working with :math:`\xi_c` data
-------------------------------

.. automodule:: pymule.xicut
   :members:

Working with plots
------------------

.. automodule:: pymule.plot
   :members:

.. automodule:: pymule.colours
   :members:

.. automodule:: pymule.mule
   :members:

.. automodule:: pymule.mpl_axes_aligner
   :members:

Useful other functions
----------------------
.. automodule:: pymule.compress
   :members:

.. automodule:: pymule.maths
   :members:


Validator
---------

The validator (cf. Section :ref:`sec_validator`) allows the checking of user files.
It is implemented as part of pymule.

Phase space generation
^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: pymule.validator.psgen
   :members:

SO loader
^^^^^^^^^

.. automodule:: pymule.validator.importer
   :members:

Validation logic
^^^^^^^^^^^^^^^^

.. automodule:: pymule.validator.validator
   :members: