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.

User Manual

• Introduction
• Release Note
  • Core software
• Installation and Setup
  • Setup HERDOS software via CVMFS
  • Install and setup HERDOS without CVMFS
• Tutorial: How to run HERDOS applications
  • Python interface
  • Run official simulation
  • Run official digitalization & reconstruction
  • Analyse data files
  • Profile your code using jMonitor
• Geometry in the software
  • Design of Geometry in HERDOS
  • Detector Details
• Detector Simulation
  • introduction
  • Physics Process
  • Digitization
• Reconstruction
  • General
  • Details
• Event Data Model
  • Basic
  • General
  • CALO
  • SCD related
  • PSD
  • FIT
  • TRD
  • Trigger
  • Global Objects
• Grid Computing
  • Grid Data Management

Developer Documentation

• HERDOS Design Scheme
  • SNiPER Framework
  • Data Management
  • Geometry Management
• Migrating standalone algorithms to HERDOS
  • Decide where to put your code.
  • Create your package
  • Migrate your code to SNiPER
  • Handle the event data
  • Handle the detector data
  • Compile and test your code
• SNiPER User Manual
  • 1. Motivation
  • 2. Architecture
  • 3. Algorithms
  • 4. Services
  • 5. Task
  • 6. Data Management
  • 7. Tools
• CMake user guide
• Gitlab user guide
  • basics
  • git settings
  • Developing, branching and merging strategy
• HERD Offline Software Naming and Coding Conventions
  • Definitions, of different naming conventions
  • Package: Naming and Directory Conventions
  • Coding Conventions
  • Documentations in Comments
  • Read more

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.