clas-stringspinner Usage Guide

Version: 2.0.0

Source Code:   clas-stringspinner  |  StringSpinner

Executable

The main executable clas-stringspinner is installed in $install_dir/bin (unless you have changed the bindir build option). See below for the Usage Guide, or run:

$install_dir/bin/clas-stringspinner --help

Usage Guide

This usage guide is for version 2.0.0. For other versions, run clas-stringspinner --help or see the release notes.


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"

  --precision PRECISION            number of decimal places for Lund-file floats
                                   default: 5

  --save-kin                       if set, save additional kinematics to text files
                                   - parsable by ROOT's TTree::ReadFile
                                   - cuts may be applied, e.g. save only pions (see code)

  --save-hipo                      if set, save additional HIPO file


BEAM AND TARGET PROPERTIES:

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

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

  --target-beam-energy ENERGY      if nonzero, the "target" is a beam with this
                                   energy, rather than a fixed target [GeV]
                                   default: 0

  --pol-type POLARIZATION_TYPE     beam and target polarization types
                                   - 2 characters: beam and target polarizations, where:
                                       U = unpolarized
                                       L = longitudinally polarized
                                       T = transversely polarized
                                   - allowed values: UU, LU, UL, LL, UT, LT
                                   default: "UU"

  --beam-spin BEAM_SPIN            the spin of the beam leptons
                                   - 1 character: 'p' or 'n', where:
                                     - if longitudinally polarized (L):
                                         p = spin along +z axis
                                         n = spin along -z axis
                                     - if transversely polarized (T): not supported
                                     - if unpolarized (U): no effect

  --target-spin TARGET_SPIN        the spin of the target nucleon
                                   - 1 character: 'p' or 'n', where:
                                     - 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

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
                                            zeus
                                   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, final state must include at least all particles
                                   with these PDG codes
                                   - the particles must be "final"; see --cut-pdg to apply to
                                     any particle, such as rho mesons
                                   - 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-pdg PDG...                 if set, event record must include at least all particles
                                   with these PDG codes
                                   - the particles may or may not be "final" (e.g, rho0 or pi+)
                                   - see --cut-inclusive for cutting on "final" particles

  --cut-pion-multiplicity MAX      if set, require the charged-pion multiplicity <= MAX

  --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-lepton-theta MIN,MAX       if set, the scattered lepton must have
                                   MIN <= theta <= MAX (units = degrees)

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


OPTIONS FOR OSG COMPATIBILITY:

  --trig NUM_EVENTS                same as --num-events
  --ebeam ENERGY                   same as --beam-energy
  --docker                         unused
    
        
Last updated: Fri Nov 13 21:26:53 UTC 2026