.. HERDOS manual master file, created by
   sphinx-quickstart on Sat Mar  19 11:22:12 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===============================
Welcome to HERDOS documentation
===============================

The HERDOS documentation includes the HERDOS user mannual, developer documentation and reference documentation.
The user mannual provides simple documentation for users who use HERDOS to generate and analyze event data.
The developer documentation describes HERDOS in detail and in depth for application developers.
The reference documentation is generated using Doxygen.

This document is maitained by HERDOS developers. Please send emails to the HERDOS developer
(<tengli@sdu.edu.cn>, <tangzhch@ihep.ac.cn>) or the software mailing list (<>) if you have any feedbacks.


.. toctree::
   :maxdepth: 2
   :caption: User Manual

   introduction/introduction.md
   release/release.md
   installation/installation.md
   run_herdos/index
   geometry/index
   detsimulation/index
   reconstruction/index
   edm/index
   gridcomputing/index

.. toctree::
   :maxdepth: 2
   :caption: Developer Documentation

   design/index
   migration/migration.md
   sniper/index
   developer_guide/cmake.md
   developer_guide/gitlab.md
   developer_guide/convension.md


About
=====
This document is maitained by HERDOS developers. Please send emails to the HERDOS developer
(<tengli@sdu.edu.cn>, <tangzhch@ihep.ac.cn>) or the software mailing list (<>) if you have any feedbacks.