Toggle navigation sidebar
Toggle in-page Table of Contents
basf2 development documentation
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.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. B2BII
3.4.12. Skimming
3.4.13. A simple python module
3.5. Offline analysis
3.5.1. ROOT
3.5.2. Pandas
3.5.3. Fitting
3.5.4. Reproducibility
3.5.5. Topology analysis
3.6. Data model and computing
3.6.1. Analysis model
3.6.2. The computing system
3.6.3. Gbasf2
3.6.4. Batch submission
3.6.5. htcondor
3.7. Workflow Management
3.7.1. b2luigi
Offline Analysis
Reconstruction on KEKcc Batch System
Skim using gbasf2
Full Workflow Execution
3.7.2. snakemake
Workflow Logic Code in the Snakefile
Separate Scripts for the Snakemake Workflow
Full Workflow Execution
3.8. Join us
3.8.1. We want YOU to contribute to this book!
3.8.2. How to contribute
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
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
5.6.1. basf2.utils - Helper functions for printing basf2 objects
5.6.2. basf2.pickle_path - Functions necessary to pickle and unpickle a Path
5.6.3. B2Tools
5.6.4. b2test_utils - Helper functions useful for test scripts
5.6.5. conditions_db
5.6.7. hep_ipython_tools
5.6.8. iov_conditional - Functions to Execute Paths Depending on Experiment Phases
5.6.9. pdg - access particle definitions
5.6.10. rundb - Helper classes for retrieving information from the RunDB
5.6.11. terminal_utils - Helper functions for input from/output to a terminal
6. List of Core Modules
7. Analysis
7.1. Particles
7.1.1. Standard Particles
7.1.2. DecayString
7.1.3. Cut strings and selections
7.2. Modular analysis convenience functions
7.2.1. ModularAnalysis
7.2.2. Photon functions
7.3. Variables
7.4. Output for offline analysis
7.4.1. Variable Manager Output
7.4.2. (Advanced) user mDST files
7.5. Vertex (and kinematic) fitting
7.5.1. Tree Fitter
7.5.2. Other vertex (and kinematic) fitters in basf2
7.5.3. Vertex-fitting convenience functions
7.5.4. Kinematic-fitting convenience functions
7.6. Event based analysis
7.7. Truth-matching
7.8. Advanced Topics
7.8.1. Rest Of Event
7.8.2. How to Veto
7.8.3. Flavor Tagger
7.8.4. Deep Flavor Tagger
7.8.5. Full event interpretation
7.8.6. Graph-based Full Event Interpretation
7.8.7. EventShape
7.8.8. Continuum suppression
7.8.9. Basf2 MVA interface
7.8.10. PID Prior Probabilities
7.8.11. ksSelector
7.8.12. PID Calibration Weights
7.8.13. Signal Embedding
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. Background module
10. Calibration
10.1.1. The Calibration Framework (CAF)
10.2.1. Prompt Calibration Tools
11. Decay Files
11.1. Event Type
12. The Belle II Event Display
13. Event Generators
13.1. Generators python modules
13.2. Modules in the Generators Package
13.3. Selective background simulation using graph neural networks
13.4. Validation
14. Tools for Validation of the SoftwareTrigger
15. KLM (
\(K_{L}^0\)
and Muon Detector)
15.3.1. Track extrapolation
15.4.1. Creation of default payloads
16. Belle II File Format
17. MVA package
18. PXD
18.1. Background Generator
19. Reconstruction
20. Simulation
Belle2 Physics List
20.3.1. Secondary Particles
20.4.1. FullSim
21. Skims
21.1. Systematics skims
21.2. Physics skims
21.3. Standard skim lists
21.4. Information for skim experts
22. SVD
22.1. SVD Reconstruction
22.2. SVD Offline Calibration
22.3. SVD Simulation
22.4. SVD Tools
22.5. SVD Utility Functions
22.6. SVD DQM
22.7. SVD DataStore
22.8. SVD DBStore
22.9. Documentation To Do List
23. Tracking
23.1. Track Parameterization
23.2. Track Finding Algorithms
23.2.1. SVD Track Finding
23.2.2. CDC Track Finding
23.2.3. Inter-Detector Hit Finding
23.2.4. Track Quality Indicator
23.3. Track Fitting
23.4. Tracking for Special Classes of Tracks
23.5. Track Refining
23.6. Track Matching
23.7. Time Extraction
23.8. PXD ROI Finding
23.9. Tracking Calibrations
23.10. Tracking Utility Functions
23.11. Tools
23.12.1. Tracking DataStore (dataobjects)
23.12.2. Database Objects
23.12.3. Data Quality Monitoring Utilities
23.12.4. Documentation of the tracking modules
23.12.5. Space Point Creation
23.12.6. SVD Region of Interest Finder
23.12.7. Tests for the tracking package
23.12.8. The tracking validation package
23.12.9. VXD Cellular Automaton Tracking
23.12.10. VXD Momentum Estimation
24. TRG
25. Tools for Physics Validation of the Software
26. Fitting training
26.1. Before you start
26.2. Fitting examples
26.2.1. Simple 1D fit
26.2.2. Efficiency fit
26.2.3. Lifetime 2D fit
26.2.4. Dalitz fit
26.3. Basic introduction to Minuit
26.3.1. Installation instructions
26.3.2. What is Minuit?
26.4. Basic introduction to Hydra
26.4.1. Installation instructions
26.4.2. What is Hydra?
26.5. Basic introduction to BAT
26.5.1. Installation instructions
26.5.2. What is BAT?
26.5.4. Simple 1D Fit with Bat
26.5.5. Simple 1D Model Comparison with BAT
26.5.6. Lifetime 2D Fit with Bat
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
.rst
.pdf
Tests for the tracking package
23.12.7.
Tests for the tracking package
#
Warning
This documentation is under construction!
