clas-stringspinner Usage Guide

$install_dir/bin/clas-stringspinner --help

USAGE: clas-stringspinner [OPTIONS]...

  --verbose                        verbose printout
  --help                           print this usage guide
  --version                        print the version number


OUTPUT FILE CONTROL:

  --num-events NUM_EVENTS          number of events
                                   warning: do not use this option on the OSG portal;
                                            instead, use the portal's options
                                   default: 10000

  --count-before-cuts              if used, --num-events will be the number of events
                                   before any cuts; the Lund file will thus have less
                                   than --num-events events
                                   default: number of output events == --num-events

  --out-file OUTPUT_FILE           output Lund file name
                                   default: "clas-stringspinner.dat"

  --save-kin                       if set, calculate additional kinematics and save
                                   them to a tables with filenames
                                     [OUTPUT_FILE].1h.table for single hadrons
                                     [OUTPUT_FILE].2h.table for dihadrons


BEAM AND TARGET PROPERTIES:

  --beam-energy ENERGY             electron beam energy [GeV]
                                   default: 10.6041

  --target-type TARGET_TYPE        target type, one of:
                                     proton
                                     neutron
                                   default: "proton"

  --pol-type POLARIZATION_TYPE     beam and target polarization types
                                   - two characters: beam and target
                                   - types: 'U' = unpolarized
                                            'L' = longitudinally polarized
                                            'T' = transversely polarized
                                   default: "UU"

  --beam-spin BEAM_SPIN            the spin of the beam leptons
                                   - if longitudinally polarized ('L'):
                                     'p' = spin along +z axis
                                     'n' = spin along -z axis
                                   - if transversely polarized ('T'):
                                     'p' = spin along +y axis
                                     'n' = spin along -y axis
                                   - if unpolarized ('U'): no effect

  --target-spin TARGET_SPIN        the spin of the target nucleons
                                   - same usage as --beam-spin, applied to target


GENERATOR PARAMETERS:

  Configuration parameters may be loaded from a configuration file (.h) from:
    https://github.com/JeffersonLab/clas-stringspinner/tree/main/src/config
  Use the --config option to choose one of them, and use the options below
  to set additional specific parameters

  --config CONFIG_NAME             Pythia configuration
                                   - choose a configuration file from one of the following:
                                            clas12
                                   default: "clas12"

  --set PARAM=VAL                  set any Pythia parameter PARAM to the value VALUE
                                   - this option is repeatable
                                   - this will OVERRIDE anything else that sets PARAM
                                   - surround your argument in single quotes (')

  --seed SEED                      random number generator seed, where:
                                   - Pythia's default seed: -1
                                   - seed based on time:  0
                                   - fixed seed:  1 to 900000000
                                   warning: do not use this option on the OSG portal,
                                            since it will be set for you automatically
                                   default: -1


CUTS FOR EVENT SELECTION:

  --cut-inclusive PDG...           if set, event must include all particles with these
                                   PDG codes
                                   - PDG... is delimited by commas; no spaces
                                   - repeat PDG codes to require more than one
                                   - example: 1 pi- and 2 pi+s:
                                       --cut-inclusive -211,211,211

  --cut-theta MIN,MAX,PDG...       if set, event must include particles such that
                                   MIN <= theta <= MAX, for all particles in PDG...
                                   - example: charged pions in 10-30 degrees:
                                       --cut-theta 10,30,211,-211

  --cut-z-2h MIN,MAX,PDG1,PDG2     if set, event must include a (PDG1, PDG2)
                                   dihadron with MIN <= dihadron z <= MAX


MISCELLANEOUS OPTIONS:

  --patch-boost                    temporary patch for boost issue:
                                   https://gitlab.com/Pythia8/releases/-/issues/529
                                   this option ensures the event record is boosted
                                   back to the fixed-target rest frame
                                   - needed for Pythia v8.312, and possibly earlier
                                   - available choices:
                                     'beam'   = derive boost from beam momentum
                                     'target' = derive boost from target momentum
                                     'none'   = do not apply any boost
                                   default: "none"

OPTIONS FOR OSG COMPATIBILITY:

  --trig NUM_EVENTS                same as --num-events
  --ebeam ENERGY                   same as --beam-energy
  --docker                         unused