==========
Python API
==========

.. rubric:: ``a5py``

.. automodule:: a5py

.. toctree::
   :hidden:

   a5py.ascot5io
   a5py.ascotpy
   a5py.templates
   a5py.physlib
   a5py.testascot
   a5py.routines
   a5py.gui

.. autosummary::

   a5py.ascot5io
   a5py.ascotpy
   a5py.templates
   a5py.physlib
   a5py.testascot
   a5py.routines
   a5py.gui

.. rubric:: Important classes

.. autosummary::
   :nosignatures:

   ~a5py.Ascot
   ~a5py.ascot5io.Ascot5IO
   ~a5py.ascot5io.RunGroup
   ~a5py.ascot5io.AfsiGroup
   ~a5py.ascot5io.BBNBIGroup
   ~a5py.routines.afsi5.Afsi
   ~a5py.routines.biosaw5.BioSaw
   ~a5py.routines.markergen.MarkerGenerator

.. rubric:: ``Ascot``

.. autoclass:: a5py.Ascot
   :members:
   :inherited-members:

.. autoclass:: a5py.routines.afsi5.Afsi
   :members:
   :inherited-members:

.. autoclass:: a5py.routines.biosaw5.BioSaw
   :members:
   :inherited-members:

.. autoclass:: a5py.routines.markergen.MarkerGenerator
   :members:
   :inherited-members:

.. rubric:: ``exceptions``

.. automodule:: a5py.exceptions
   :members: