Belle 2 Software Documentation

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

Note

Generated on May 07, 2021 for release light-2104-poseidon, commit 9fd39bc923.

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. Belle II Software Tools
  • 2.2. Local Installation
  • 2.3. Setup of the Belle II Software
• 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. Belle II File Format
  • 8.1. Python interface
  • 8.2. C++ dataobjects
  • 8.3. ROOT and compatibility guarantee
  • 8.4. Related packages
• 9. MVA package
  • 9.1. Overview
  • 9.2. Supported frameworks/backends
  • 9.3. Using the mva package
  • 9.4. How to upload/download the training into the database
  • 9.5. Examples
  • 9.6. Contributions
  • 9.7. Python-based frameworks
  • 9.8. Backward Compatibility
  • 9.9. Reading List
• 10. Skims
  • 10.1. Systematics skims
  • 10.2. Physics skims
  • 10.3. Standard skim lists
  • 10.4. Information for skim experts
• 11. How to document your code with Sphinx
  • 11.1. Documentation of Python Code
  • 11.2. Referencing Components
  • 11.3. Inserting Figures
  • 11.4. Documentation of Variables and Modules in C++
  • 11.5. Google Style Docstrings
  • 11.6. Add Basf2 Modules Documentation to Sphinx
  • 11.7. Add Basf2 Variables Documentation to Sphinx
  • 11.8. Additional Features
  • 11.9. Additional boxes for the online lessons
  • 11.10. How to test locally
  • 11.11. Previewing documentation changes in a pull request
• 12. Online textbook
  • 12.1. Welcome!
  • 12.2. Fundamentals
  • 12.3. Software Prerequisites
  • 12.4. Working with Belle II software.
  • 12.5. Offline analysis
  • 12.6. Data model and computing
  • 12.7. Join us

Indices and tables

• Index

• Module Index

• Basf2 Module Index

• Basf2 Variable Index

• Search Page