5. 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.

• 5.1. basf2: The Main Belle2 Software Executable
• 5.2. Tools for file handling
  • 5.2.1. b2file-metadata-show: Show the metadata of a basf2 output file
  • 5.2.2. b2file-metadata-add: Add/Edit LFN in given file
  • 5.2.3. b2file-catalog-add: Add a file to a local XML file catalog
  • 5.2.4. b2file-check: Check a basf2 output file for consistency
    • Positional Arguments
    • Named Arguments
  • 5.2.5. b2file-merge: Merge multiple basf2 output files
  • 5.2.6. b2file-mix: Create a run of mixed data from a set of input files
    • Positional Arguments
    • Named Arguments
  • 5.2.7. b2file-remove-branches: Create a copy of a basf2 output file removing a list of given branches in the process
    • Positional Arguments
    • Named Arguments
  • 5.2.8. b2file-size: Show detailed size information about the content of a file
    • Positional Arguments
    • Named Arguments
    • Visual Options
    • Graph Options
  • 5.2.9. b2file-normalize: Reset non-reproducible root file metadata and optionally the file name in the metadata
    • Positional Arguments
    • Named Arguments
  • 5.2.10. b2file-md5sum: Calculate a md5 checksum of a root file content excluding the root metadata
    • Positional Arguments
    • Named Arguments
• 5.3. Testing Tools
  • 5.3.1. b2test-units: Run unittests
  • 5.3.2. b2test-scripts: Run framework tests
    • Positional Arguments
    • Named Arguments
• 5.4. Tools which will provide you help
  • 5.4.1. b2help-modules: List available basf2 modules and ask about their details
    • Positional Arguments
  • 5.4.2. b2help-particles: List particles used in the event generator
    • Positional Arguments
    • Named Arguments
  • 5.4.3. b2help-recommendation: Tool to print analysis recommendations
    • Named Arguments
  • 5.4.4. b2help-variables: List available variables in the analysis package
    • Named Arguments
  • 5.4.5. b2help-print-fei-mode-names: List available FEI modes for a given particle
    • Positional Arguments
    • Named Arguments
  • 5.4.6. b2help-print-mcparticles: Print the MCParticles in the input mdst file
• 5.5. Tools to help with debugging and checking code quality
  • 5.5.1. b2code-module: Create a source code template for a module
    • Positional Arguments
  • 5.5.2. b2code-memoryusage: Show memory usage of a program
    • Named Arguments
  • 5.5.3. b2code-findsymbol: Look for a given C++ symbol
  • 5.5.4. b2code-doxygen-warnings: Show warnings when running doxygen
  • 5.5.5. b2code-classversion-check: Perform sanity checks on ROOT class versions
    • Positional Arguments
    • Named Arguments
  • 5.5.6. b2code-classversion-update: Update linkdef information for sanity checks
    • Positional Arguments
  • 5.5.7. b2code-cppcheck: Run cppcheck static analyzer
  • 5.5.8. b2code-option: Set up the environment for selected compiler options
  • 5.5.9. b2code-parallel_processing-benchmark: Measure multi-core performance
    • Named Arguments
  • 5.5.10. b2code-sphinx-build: Build the sphinx documentation
  • 5.5.11. b2code-sphinx-warnings: Show all the warnings when building the documentation
• 5.6. b2conditionsdb: Conditions DB interface
  • 5.6.1. Named Arguments
  • 5.6.2. Sub-commands
    • diff
      • Positional Arguments
      • Named Arguments
    • download
      • Positional Arguments
      • Named Arguments
    • dump
      • Named Arguments
    • iov
      • Positional Arguments
      • Named Arguments
    • iovs
      • Named Arguments
      • Sub-commands
        • copy
          • Positional Arguments
          • Named Arguments
        • delete
          • Positional Arguments
          • Named Arguments
        • modify
          • Positional Arguments
          • Named Arguments
    • legacydownload
      • Positional Arguments
      • Named Arguments
    • tag
      • Named Arguments
      • Sub-commands
        • clone
          • Positional Arguments
          • Named Arguments
        • create
          • Positional Arguments
          • Named Arguments
        • list
          • Named Arguments
        • merge
          • Positional Arguments
          • Named Arguments
          • required named arguments
        • modify
          • Positional Arguments
          • Named Arguments
        • runningupdate
          • Positional Arguments
          • Named Arguments
          • required named arguments
        • show
          • Positional Arguments
          • Named Arguments
        • state
          • Positional Arguments
          • Named Arguments
    • upload
      • Positional Arguments
      • Named Arguments
  • 5.6.3. b2conditionsdb-extract: Extract payload for a run range and save as TTree
    • Positional Arguments
    • Named Arguments
  • 5.6.4. b2conditionsdb-recommend: Recommend a global tag to analyse a given file
    • Positional Arguments
    • Named Arguments
  • 5.6.5. b2conditionsdb-request: Request inclusion of payloads in official global tag
    • Positional Arguments
    • Named Arguments
• 5.7. Tools for luminosity
  • 5.7.1. b2info-luminosity: Show the luminosity corresponding to a given experiment(s)
    • Named Arguments
• 5.8. Tools for ParticleStats
  • 5.8.1. b2plot-particleStats: Analyze a json produced by ParticleStats to produce plot of retention rate and pass matrix
    • Named Arguments