Belle 2 Software Documentation

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

Note

Generated on Jan 16, 2023 for release light-2212-foldex, commit b0d2ffdec.

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 Beginners’ tutorials, 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. Beginners’ tutorials
  • 3.1. Welcome!
  • 3.2. Fundamentals
  • 3.3. Software Prerequisites
  • 3.4. Working with Belle II software.
  • 3.5. Offline analysis
  • 3.6. Data model and computing
  • 3.7. Join us
• 4. Command Line Tools
  • 4.1. basf2: The Main Belle2 Software Executable
  • 4.2. Tools for file handling
  • 4.3. Testing Tools
  • 4.4. Tools which will provide you help
  • 4.5. Tools to help with debugging and checking code quality
  • 4.6. b2conditionsdb: Conditions DB interface
  • 4.7. Tools for luminosity
  • 4.8. Tools for ParticleStats
• 5. Belle II Python Interface
  • 5.1. Modules and Paths
  • 5.2. Logging
  • 5.3. Module Statistics
  • 5.4. Conditions Database
  • 5.5. Additional Functions
  • 5.6. Other Modules
• 6. List of Core Modules
• 7. Analysis
  • 7.1. Particles
  • 7.2. Modular analysis convenience functions
  • 7.3. Variables
  • 7.4. Output for offline analysis
  • 7.5. Vertex (and kinematic) fitting
  • 7.6. Event based analysis
  • 7.7. Truth-matching
  • 7.8. Advanced Topics
  • 7.9. Full list of analysis modules
• 8. B2BII
  • 8.1. Overview
  • 8.2. B2BII Analysis
  • 8.3. Converted data objects and other information
  • 8.4. Belle MDST samples
  • 8.5. FAQ
  • 8.6. b2bii functions
• 9. Belle II File Format
  • 9.1. Python interface
  • 9.2. C++ dataobjects
  • 9.3. ROOT and compatibility guarantee
  • 9.4. Related packages
• 10. MVA package
  • 10.1. Overview
  • 10.2. Supported frameworks/backends
  • 10.3. Using the mva package
  • 10.4. How to upload/download the training into the database
  • 10.5. Examples
  • 10.6. Contributions
  • 10.7. Python-based frameworks
  • 10.8. Backward Compatibility
  • 10.9. Reading List
• 11. Skims
  • 11.1. Systematics skims
  • 11.2. Physics skims
  • 11.3. Standard skim lists
  • 11.4. Information for skim experts
• 12. Software development
  • 12.1. How to write basf2 code (coding conventions)
  • 12.2. Updating the main globaltag
• 13. How to document your code with Sphinx
  • 13.1. Documentation of Python Code
  • 13.2. Referencing Components
  • 13.3. Inserting Figures
  • 13.4. Documentation of Variables and Modules in C++
  • 13.5. Google Style Docstrings
  • 13.6. Add basf2 Modules Documentation to Sphinx
  • 13.7. Add basf2 Variables Documentation to Sphinx
  • 13.8. Additional Features
  • 13.9. Additional boxes for the online lessons
  • 13.10. How to test locally
  • 13.11. Previewing documentation changes in a pull request

Indices and tables

• Index

• Module Index

• basf2 Module Index

• basf2 Variable Index

• Search Page