Tools which will provide you help

4.4. Tools which will provide you help#

4.4.1. b2help-modules: List available basf2 modules and ask about their details#

This returns either all available modules within basf2 or returs specific information about a module when requested.

Usage:

b2help-modules will return the full list of available modules. b2help-modules PACKAGE will return a list of modules associated with the given PACKAGE name. b2help-modules MODULENAME will return specific information about the module with the name MODULENAME.

usage: b2help-modules [-h] [module]

Required Arguments

module

Get information specific to the requested module.

4.4.2. b2help-particles: List particles used in the event generator#

Utility to list and search the particle data known to the Belle II Software.

Just calling this program will print a list of all known particles which can be searched by name and mass using command line arguments

usage: b2help-particles [-h] [--min-mass MIN] [--max-mass MAX]
                        [--include-width N] [--regex] [-s {pdg,name,mass}]
                        [-r] [--pdg PDG]
                        [NAME]

Required Arguments

NAME

Optional name to search for in particles

options

--min-mass

Minimum mass for all particles to print

--max-mass

Maximum mass for all particles to print

--include-width

When searching for particles by mass this argument can be given to include all particles which fullfill the mass search within (mass +- N*width)

--regex

If given the name will be interpreted as a python regular expression

-s, --sort

Possible choices: pdg, name, mass

sort the list by the given value

-r, --reverse

reverse sorting if given

--pdg

If given show particles with the given PDG Code

4.4.3. b2help-recommendation: Tool to print analysis recommendations#

Outputs recommendation for data/MC corrections and systematics, use tags to navigate.

usage: b2help-recommendation [-h] [-t TAGS [TAGS ...]] [-gt GLOBALTAG]
                             [-p PAYLOAD] [-m MCCAMPAIGN] [-l LOCALFILE] [-c]

options

-t, --tags

Filter tools by specific tags. The ‘all’ tag allows to show all information.

-gt, --globaltag

Global tag name, if one wants to check another recommendation

-p, --payload

Payload name, if one wants to check another recommendation

-m, --mccampaign

Show recommendations for this MC campaign and the corresponding data processing

-l, --localfile

If one wants to check a json file locally.

-c, --convert

For developers. Convert the localfile to a payload.

4.4.4. b2help-variables: List available variables in the analysis package#

This command returns a description of the variables which are available in the Analysis package of basf2.

  • To display all available variables,

    b2help-variables

  • To get a description of specific variables,

    b2help-variables --variables M Mbc isSignal

  • To get only the data type of the variables,

    b2help-variables --variables M Mbc isSignal --only_type

usage: b2help-variables [-h] [--no-pager]
                        [--variables VARIABLES [VARIABLES ...]] [--only_type]

options

--no-pager

Use a pager to show output or print to terminal.

--variables

Input variables to be displayed.

--only_type

Show only the data type of the variable. This option requires the variable names with the --variables option.

4.4.5. b2help-print-mcparticles: Print the MCParticles in the input mdst file#

This command prints the MCParticles of the input mdst file and outputs an ntuple including __MCDecayString__. Default output file name is ntuple.root.

You can use any of basf2’s options, e.g. -o, -n, and --skip-events. Specifically, -i is required to select the input mdst file.

usage: b2help-print-mcparticles [-h] [-i INPUT]

Required Arguments

-i INPUT, --input INPUT

input mdst file name

Optional Arguments

-h, --help

show this help message and exit

Contents