Belle 2 Software Documentation

This document contains documentation of the Belle 2 Software, its command line tools and the Python API.

Note

Generated on Dec 08, 2023 for release release-06-01-15, commit 165f25535.

In case of questions regarding the Belle 2 Software or for additional information, please check Belle 2 Questions.

Tip

If you are new to the Belle 2 Software, you might want to take a look at the Online textbook, a series of lessons that get you started in no time!

---

• 1. What’s New
• 2. Installation and Setup
  • 2.1. Setup of the Belle II Software
  • 2.2. Belle II Software Tools
  • 2.3. Local Installation
• 3. Command Line Tools
  • 3.1. basf2: The Main Belle2 Software Executable
  • 3.2. Tools for file handling
  • 3.3. Testing Tools
  • 3.4. Tools which will provide you help
  • 3.5. Tools to help with debugging and checking code quality
  • 3.6. b2conditionsdb: Conditions DB interface
  • 3.7. Tools for luminosity
  • 3.8. Tools for ParticleStats
• 4. Belle II Python Interface
  • 4.1. Modules and Paths
  • 4.2. Logging
  • 4.3. Module Statistics
  • 4.4. Conditions Database
  • 4.5. Additional Functions
  • 4.6. Other Modules
• 5. List of Core Modules
• 6. Analysis
  • 6.1. Particles
  • 6.2. Modular analysis convenience functions
  • 6.3. Variables
  • 6.4. Output for offline analysis
  • 6.5. Vertex (and kinematic) fitting
  • 6.6. Event-based analysis
  • 6.7. Truth-matching
  • 6.8. Advanced Topics
  • 6.9. Full list of analysis modules
• 7. B2BII
  • 7.1. b2biiConversion
  • 7.2. b2biiMonitors
• 8. Background module
• 9. Calibration
  • 9.1. Calibration Framework (CAF)
  • 9.2. Prompt Calibration
• 10. The Belle II Event Display
  • 10.1. Starting the display
  • 10.2. Viewer navigation and the user interface
  • 10.3. Visualised objects
  • 10.4. Window management
  • 10.5. Troubleshooting
  • 10.6. Module documentation
• 11. Event Generators
  • 11.1. The generators Python Module
  • 11.2. Modules in the Generators Package
• 12. Tools for Validation of the SoftwareTrigger
  • 12.1. b2hlt_combine_results.py
• 13. KLM (\(K_{L}^0\) and Muon Detector)
  • 13.1. Modules
  • 13.2. Clusterization
  • 13.3. Muon identification
  • 13.4. Calibration
  • 13.5. Tools
• 14. Belle II File Format
  • 14.1. Python interface
  • 14.2. C++ dataobjects
  • 14.3. ROOT and compatibility guarantee
  • 14.4. Related packages
• 15. MVA package
  • 15.1. Overview
  • 15.2. Supported frameworks/backends
  • 15.3. Using the mva package
  • 15.4. How to upload/download the training into the database
  • 15.5. Examples
  • 15.6. Contributions
  • 15.7. Python-based frameworks
  • 15.8. Backward Compatibility
  • 15.9. Reading List
• 16. PXD
  • 16.1. Background Generator
• 17. Reconstruction
  • 17.1. Functions in reconstructions.py
• 18. Simulation
  • 18.1. Geant4 version in the externals library
  • 18.2. Physics list for Geant4
  • 18.3. Secondary particles
  • 18.4. FullSim
  • 18.5. Functions in simulation.py
• 19. Skims
  • 19.1. Systematics skims
  • 19.2. Physics skims
  • 19.3. Standard skim lists
  • 19.4. Information for skim experts
• 20. SVD
  • 20.1. SVD Reconstruction
  • 20.2. SVD Offline Calibration
  • 20.3. SVD Simulation
  • 20.4. SVD Tools
  • 20.5. SVD Utility Functions
  • 20.6. SVD DQM
  • 20.7. SVD DataStore
  • 20.8. SVD DBStore
  • 20.9. Documentation To Do List
• 21. Tracking
  • 21.1. Track Finding Algorithms
  • 21.2. Track Fitting
  • 21.3. Tracking for Special Classes of Tracks
  • 21.4. PXD ROI Finding
  • 21.5. Tracking Calibrations
  • 21.6. Tracking Utility Functions
  • 21.7. Tools
  • 21.8. Tracking Glossary
  • 21.9. More ?
• 22. TRG
  • 22.1. Functions in mdst.py
• 23. Tools for Physics Validation of the Software
  • 23.1. Command line utilities
  • 23.2. Convenience Functions
• 24. Fitting training
  • 24.1. Before you start
  • 24.2. Fitting examples
  • 24.3. Basic introduction to Minuit
  • 24.4. Basic introduction to Hydra
  • 24.5. Basic introduction to BAT
  • 24.6. Contributors
• 25. How to document your code with Sphinx
  • 25.1. Documentation of Python Code
  • 25.2. Referencing Components
  • 25.3. Inserting Figures
  • 25.4. Documentation of Variables and Modules in C++
  • 25.5. Google Style Docstrings
  • 25.6. Add basf2 Modules Documentation to Sphinx
  • 25.7. Add basf2 Variables Documentation to Sphinx
  • 25.8. Additional Features
  • 25.9. Additional boxes for the online lessons
  • 25.10. How to test locally
  • 25.11. Previewing documentation changes in a pull request
• 26. Online textbook
  • 26.1. Welcome!
  • 26.2. Fundamentals
  • 26.3. Software Prerequisites
  • 26.4. Working with Belle II software.
  • 26.5. Offline analysis
  • 26.6. Data model and computing
  • 26.7. Join us

Indices and tables

• Index

• Module Index

• basf2 Module Index

• basf2 Variable Index

• Search Page