API Reference
================================

All public symbols are re-exported from the top-level :mod:`albums` package and
documented below in their defining submodule.

Submodules
----------

.. toctree::
   :maxdepth: 4

albums.mbtrack2\_to\_pycolleff
.....................................

.. automodule:: albums.mbtrack2_to_pycolleff
   :members:
   :show-inheritance:
   :undoc-members:

albums.optimiser
.......................

.. automodule:: albums.optimiser
   :members:
   :show-inheritance:
   :undoc-members:

albums.options
.....................

.. automodule:: albums.options
   :members:
   :show-inheritance:
   :undoc-members:

albums.plot\_func
........................

.. automodule:: albums.plot_func
   :members:
   :show-inheritance:
   :undoc-members:

albums.system
......................

.. automodule:: albums.system
   :members:
   :show-inheritance:
   :undoc-members:

albums.equilibrium
.........................

.. automodule:: albums.equilibrium
   :members:
   :show-inheritance:
   :undoc-members:

albums.theories
......................

.. automodule:: albums.theories
   :members:
   :show-inheritance:
   :undoc-members:

albums.flow
..................

.. automodule:: albums.flow
   :members:
   :show-inheritance:
   :undoc-members:

albums.saveload
......................

.. automodule:: albums.saveload
   :members:
   :show-inheritance:
   :undoc-members:

albums.scan
..................

.. automodule:: albums.scan
   :members:
   :show-inheritance:
   :undoc-members:

albums.result\_io
........................

.. automodule:: albums.result_io
   :members:
   :show-inheritance:
   :undoc-members:

Physics kernel
--------------

albums.physics.potential
...............................

.. automodule:: albums.physics.potential
   :members:
   :show-inheritance:
   :undoc-members:

albums.physics.robinson
..............................

.. automodule:: albums.physics.robinson
   :members:
   :show-inheritance:
   :undoc-members:

albums.physics.zero\_frequency
.....................................

.. automodule:: albums.physics.zero_frequency
   :members:
   :show-inheritance:
   :undoc-members:

albums.physics.coupled\_bunch
....................................

.. automodule:: albums.physics.coupled_bunch
   :members:
   :show-inheritance:
   :undoc-members:

albums.physics.ptbl
..........................

.. automodule:: albums.physics.ptbl
   :members:
   :show-inheritance:
   :undoc-members: