Skip to main content
Back to top
Ctrl
+
K
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
2.4.
b2venv
: Using basf2 in a virtual environment
3. Beginners’ Tutorials
3.1. Welcome!
3.1.1. Collaborative Tools.
3.2. Fundamentals
3.2.1. Introduction
3.2.2. Data Taking
3.2.3. Simulation: The Monte Carlo
3.2.4. Reconstruction
3.2.5. Analysis
3.3. Software Prerequisites
3.3.1. Command Line Tutorial (Bash)
3.3.2. SSH - Secure Shell
3.3.3. Python
3.3.4. Version Control with Git
3.4. Working with Belle II software.
3.4.1. The basics.
3.4.2. First steering file
3.4.3. The Rest of Event (ROE)
3.4.4. Various additions
3.4.5. Flavor tagging
3.4.6. Vertex fitting
3.4.7. Event display
3.4.8. Generating Monte Carlo
3.4.9. Full Event Interpretation
3.4.10. Continuum Suppression (CS)
3.4.11. ONNX MVA tutorial
3.4.12. B2BII
3.4.13. Skimming
3.4.14. A simple python module
3.5. Offline analysis
3.5.1. Plotting
3.5.2. ROOT
3.5.3. Pandas
3.5.4. Fitting Resources
3.5.5. Reproducibility
3.5.6. Topology analysis
3.6. Workflow Management
3.6.1. b2luigi
Offline Analysis
Reconstruction on KEKcc Batch System
Skim using gbasf2
Full Workflow Execution
3.6.2. Checkpointing for machine learning
3.6.3. snakemake
Workflow Logic Code in the Snakefile
Separate Scripts for the Snakemake Workflow
Full Workflow Execution
3.7. Join us
3.7.1. We want YOU to contribute to this book!
3.7.2. How to contribute
4. Resources
5. Command Line Tools
5.1.
basf2
: The Main Belle2 Software Executable
5.2. Tools for file handling
5.3. Testing Tools
5.4. Tools which will provide you help
5.5. Tools to help with debugging and checking code quality
5.6.
b2conditionsdb
: Conditions DB interface
5.7. Tools for luminosity
6. Belle II Python Interface
6.1. Modules and Paths
6.2. Logging
6.3. Module Statistics
6.4. Conditions Database
6.5. Additional Functions
6.6. Pythonizations
6.7. Other Modules
6.7.1. basf2.utils - Helper functions for printing basf2 objects
6.7.2. basf2.pickle_path - Functions necessary to pickle and unpickle a Path
6.7.3. B2Tools
6.7.4. b2test_utils - Helper functions useful for test scripts
6.7.5. conditions_db
6.7.7. hep_ipython_tools
6.7.8. iov_conditional - Functions to Execute Paths Depending on Experiment Phases
6.7.9. pdg - access particle definitions
6.7.10. rundb - Helper classes for retrieving information from the RunDB
6.7.11. terminal_utils - Helper functions for input from/output to a terminal
7. List of Core Modules
8. Analysis
8.1. Particles
8.1.1. Standard Particles
8.1.2. DecayString
8.1.3. Cut strings and selections
8.2. Modular analysis convenience functions
8.2.1. ModularAnalysis
8.2.2. Photon functions
8.3. Variables
8.4. Output for offline analysis
8.4.1. Variable Manager Output
8.4.2. (Advanced) user mDST files
8.5. Vertex (and kinematic) fitting
8.5.1. Tree Fitter
8.5.2. Other vertex (and kinematic) fitters in basf2
8.5.3. Vertex-fitting convenience functions
8.5.4. Kinematic-fitting convenience functions
8.6. Event based analysis
8.7. Truth-matching
8.8. Advanced Topics
8.8.1. Rest Of Event
8.8.2. How to Veto
8.8.3. Flavor Tagger
8.8.4. Transformer Flavor Tagger (TFlaT)
8.8.5. Deep Flavor Tagger
8.8.6. Charm Flavor Tagger
8.8.7. Full event interpretation
8.8.8. ModeSelector
8.8.9. Graph-based Full Event Interpretation
8.8.10. EventShape
8.8.11. Continuum suppression
8.8.12. Basf2 MVA interface
8.8.13. PID Prior Probabilities
8.8.14. ksSelector
8.8.15. PID Calibration Weights
8.8.16. Signal Embedding
8.8.17. Offline reweighting
8.9. Full list of analysis modules
9. B2BII
9.1. Overview
9.2. B2BII Analysis
9.3. Converted data objects and other information
9.4. Belle MDST samples
9.5. FAQ
9.6. b2bii functions
10. Background Package
11. Calibration
11.1.1. The Calibration Framework (CAF)
11.2.1. Prompt Calibration Tools
12. Decay Files
12.1. Event Type
13. The Belle II Event Display
14. Event Generators
14.1. Generators python modules
14.2. Modules in the Generators Package
14.3. Validation
15. Tools for Validation of the SoftwareTrigger
16. KLM (
\(K_{L}^0\)
and Muon Detector)
16.3.1. Track extrapolation
16.4.1. Creation of default payloads
17. Belle II File Format
18. MVA package
ONNX tips and tricks
19. PXD
19.1. Background Generator
20. Reconstruction
21. Simulation
Belle2 Physics List
21.3.1. Secondary Particles
21.4.1. FullSim
22. Skims
22.1. Systematics skims
22.2. Physics skims
22.3. Standard skim lists
22.4. Information for skim experts
22.5. Smart Background Simulation
23. SVD
23.1. SVD Reconstruction
23.2. SVD Offline Calibration
23.3. SVD Simulation
23.4. SVD Tools
23.5. SVD Utility Functions
23.6. SVD DQM
23.7. SVD DataStore
23.8. SVD DBStore
23.9. SVD Variables
24. Tracking
24.1. Track Parameterization
24.2. Track Finding Algorithms
24.2.1. SVD Track Finding
SectorMap training
24.2.2. CDC Track Finding
24.2.3. Inter-Detector Hit Finding
24.2.4. Track Quality Indicator
24.3. Track Fitting
24.4. Tracking for Special Classes of Tracks
24.5. Track Refining
24.6. Track Matching
24.7. Time Extraction
24.8. PXD ROI Finding
24.9. Tracking Calibrations
24.10. Tracking Utility Functions
24.11. Tools
24.12.1. Tracking DataStore (dataobjects)
24.12.2. Database Objects
24.12.3. Data Quality Monitoring Utilities
24.12.4. Documentation of the tracking modules
24.12.5. Space Point Creation
24.12.6. SVD Region of Interest Finder
24.12.7. Tests for the tracking package
24.12.8. The tracking validation package
24.12.9. VXD Momentum Estimation
25. TRG
26. Tools for Physics Validation of the Software
27. Software development
27.1. How to write
basf2
code (coding conventions)
27.2. Updating the main globaltag
28. How to document your code with Sphinx
28.1. Documentation of Python Code
28.2. Referencing Components
28.3. Inserting Figures
28.4. Documentation of Variables and Modules in C++
28.5. Google Style Docstrings
28.6. Add
basf2
Modules Documentation to Sphinx
28.7. Add
basf2
Variables Documentation to Sphinx
28.8. Additional Features
28.9. Additional boxes for the online lessons
28.10. How to test locally
28.11. Previewing documentation changes in a merge request
29. Software publications
.rst
.pdf
Documentation of the tracking modules
24.12.4.
Documentation of the tracking modules
#
Warning
This documentation is under construction!
