index.rst

.. only:: noconfig

   .. warning::

      This autogenerated documentation is incomplete because it was not built
      with all optional dependencies (breathe, sphinxbib, cmake). Please visit
      the `Celeritas documentation`_ hosted on GitHub pages for the full
      documentation.

      .. _Celeritas documentation: https://celeritas-project.github.io/celeritas/user/index.html

Celeritas

Celeritas is a Monte Carlo particle transport code for simulating High Energy Physics detectors on general purpose GPUs. Motivated by the massive computational requirements of the High Luminosity upgrade to the Large Hadron Collider, the code's initial goal is to accelerate electromagnetic physics simulations of the CMS and ATLAS detectors.

.. only:: html

   :Release: |release|
   :Date: |today|

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

   main/introduction.rst
   main/overview.rst
   main/installation.rst
   main/usage.rst
   main/api.rst
   main/examples.rst
   main/references.rst
   main/acknowledgments.rst

.. toctree::
   :maxdepth: 2
   :caption: Appendices

   appendix/release-history.rst
   appendix/development.rst
   appendix/administration.rst
   appendix/license.rst