4. Command Line Tools#
The Belle2 Software provides a number of command line tools for general use,
including tools to work with files, to help with debugging/testing or for
validation purposes. The general rule is that all tools which are intended to
be useful for most users should start with the name b2 followed by a usage
category, for example b2file for all tools for file handling. Sub
categories should be added using - signs, for example
b2file-metadata-show is a tool intended to show the metadata embedded into
files created by the Belle2 Software.
- 4.1.
basf2: The Main Belle2 Software Executable - 4.2. Tools for file handling
- 4.2.1.
b2file-metadata-show: Show the metadata of a basf2 output file - 4.2.2.
b2file-metadata-add: Add/Edit LFN in given file - 4.2.3.
b2file-catalog-add: Add a file to a local XML file catalog - 4.2.4.
b2file-check: Check a basf2 output file for consistency - 4.2.5.
b2file-merge: Merge multiple basf2 output files - 4.2.6.
b2file-mix: Create a run of mixed data from a set of input files - 4.2.7.
b2file-remove-branches: Create a copy of a basf2 output file removing a list of given branches in the process - 4.2.8.
b2file-size: Show detailed size information about the content of a file - 4.2.9.
b2file-normalize: Reset non-reproducible root file metadata and optionally the file name in the metadata - 4.2.10.
b2file-md5sum: Calculate a md5 checksum of a root file content excluding the root metadata
- 4.2.1.
- 4.3. Testing Tools
- 4.4. Tools which will provide you help
- 4.4.1.
b2help-modules: List available basf2 modules and ask about their details - 4.4.2.
b2help-particles: List particles used in the event generator - 4.4.3.
b2help-recommendation: Tool to print analysis recommendations - 4.4.4.
b2help-variables: List available variables in the analysis package - 4.4.5.
b2help-print-mcparticles: Print the MCParticles in the input mdst file
- 4.4.1.
- 4.5. Tools to help with debugging and checking code quality
- 4.5.1.
b2code-module: Create a source code template for a module - 4.5.2.
b2code-memoryusage: Show memory usage of a program - 4.5.3.
b2code-findsymbol: Look for a given C++ symbol - 4.5.4.
b2code-doxygen-warnings: Show warnings when running doxygen - 4.5.5.
b2code-classversion-check: Perform sanity checks on ROOT class versions - 4.5.6.
b2code-classversion-update: Update linkdef information for sanity checks - 4.5.7.
b2code-cppcheck: Run cppcheck static analyzer - 4.5.8.
b2code-option: Set up the environment for selected compiler options - 4.5.9.
b2code-parallel_processing-benchmark: Measure multi-core performance - 4.5.10.
b2code-sphinx-build: Build the sphinx documentation - 4.5.11.
b2code-sphinx-warnings: Show all the warnings when building the documentation
- 4.5.1.
- 4.6.
b2conditionsdb: Conditions DB interface- 4.6.1. Sub-command
b2conditionsdb diff - 4.6.2. Sub-command
b2conditionsdb download - 4.6.3. Sub-command
b2conditionsdb dump - 4.6.4. Sub-command
b2conditionsdb iov - 4.6.5. Sub-command
b2conditionsdb iovs - 4.6.6. Sub-command
b2conditionsdb legacydownload - 4.6.7. Sub-command
b2conditionsdb tag- Sub-command
b2conditionsdb tag clone - Sub-command
b2conditionsdb tag create - Sub-command
b2conditionsdb tag list - Sub-command
b2conditionsdb tag merge - Sub-command
b2conditionsdb tag modify - Sub-command
b2conditionsdb tag runningupdate - Sub-command
b2conditionsdb tag show - Sub-command
b2conditionsdb tag state
- Sub-command
- 4.6.8. Sub-command
b2conditionsdb upload - 4.6.9.
b2conditionsdb-extract: Extract payload for a run range and save as TTree - 4.6.10.
b2conditionsdb-recommend: Recommend a global tag to analyse a given file - 4.6.11.
b2conditionsdb-request: Request inclusion of payloads in official global tag
- 4.6.1. Sub-command
- 4.7. Tools for luminosity
- 4.8. Tools for ParticleStats