.. BLonD documentation master file, created by
   sphinx-quickstart on Fri Mar 10 19:37:27 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the BLonD documentation!
===================================

Contents
========
The Beam Longitudinal Dynamics code BLonD is a CERN software package for the
simulatation of longitudinal beam dynamics in synchrotrons.

Visit the BLonD website_ for more details and the github_ distribution to 
download the code.

.. _website: http://blond.web.cern.ch/
.. _github: https://github.com/blond-admin/BLonD/releases

Modules
=======

.. toctree::
    :maxdepth: 2

    modules/equations_of_motion.rst
    modules/lhc_cavity_loop.rst
    modules/sps_cavity_loop.rst
    modules/beam.rst
    modules/impedances.rst
    modules/input_parameters.rst
    modules/llrf.rst
    modules/monitors.rst
    modules/plots.rst
    modules/synchrotron_radiation.rst
    modules/toolbox.rst
    modules/trackers.rst
    modules/compile.rst
    modules/utils.rst



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`