Python Module Index

a | b | c | d | e | i | l | m | n | p | r | s | t | w | x
 
a
asciiGraph Contains a simple routine to draw ASCII-art Feynman-like graphs.
auxiliaryFunctions A collection of functions used to evaluate fuzzy the conditions.
 
b
branch Module holding the branch class and methods.
 
c
caching The memoize technique, for caching.
clusterTools Module holding the ElementCluster class and cluster methods used to combine similar elements according to the analysis.
colors Simple facility to handle console colors
combinations a module to contain the logic around combinations, be they SL-based or pyhf-based.
coverage Definitions of classes used to find, group and format missing topologies
crashReport Facility used in runSModelS.py to create and read SModelS crash report files.
crossSection Encapsulates the result of the computation of the reference cross section.
 
d
databaseBrowser Centralized facility to access smodels-database.
databaseObj Contains Database class that represents the database of experimental results.
databaseParticles Defines the final state particles used in the experimental results.
datasetObj Holds the classes and methods used to read and store the information in the data folders.
Decomposer Decomposition of SLHA events and creation of TopologyLists.
dgmssm Defines the BSM particles to be used. Properties not defined here and defined by the LHE or SLHA input file (such as masses, width and BRs) are automatically added later.
 
e
element Module holding the Element class and its methods.
experiment
    experiment.__init__ This package is intended to contain everything that has to do with the experimental results.
    experiment.databaseObj
    experiment.datasetObj
    experiment.defaultFinalStates
    experiment.exceptions
    experiment.expResultObj
    experiment.infoObj
    experiment.metaObj
    experiment.txnameObj
experimentExceptions Contains exceptions for SModelS's experiment package.
expResultObj Contains class that encapsulates an experimental result
externalPythonTools This module is to check the installation of python tools, i.e. unum, scipy, numpy, pyslha.
 
i
idm Defines the BSM particles to be used. Properties not defined here and defined by the LHE or SLHA input file (such as masses, width and BRs) are automatically added later.
inclusiveObjects Module holding multipurpose inclusive objects
infoObj Holds the classes and methods used to read and store the information in the globalInfo.txt or dataInfo.txt files.
interactive_plots Main module of the interactive plots.
interactivePlotsHelpers Main functions for producing interactive plots
ioObjects Definitions of input/output parameters which are read from parameter.in.
 
l
lheChecks Check LHE file format.
lheReader Provides a class that creates SMSEvents from LHE files.
 
m
metaObj Contains the Meta object used to track the provenance of the pickle file.
model Create model from file
modelTester Functions to test (a set of) points, handling decomposition, result and coverage checks, parallelisation.
mssm Defines the BSM particles to be used. Properties not defined here and defined by the LHE or SLHA input file (such as masses, width and BRs) are automatically added later.
 
n
nllFastWrapper This module provides methods to access the nllfast grid and compute k-factors (when available) to SUSY pair production cross sections.
nmssm Defines the BSM particles to be used. Properties not defined here and defined by the LHE or SLHA input file (such as masses, width and BRs) are automatically added later.
 
p
particle Defines the particle, multiparticle and particle list classes, their methods and related functions
physicsUnits This introduces physical units (GeV, fb) to the framework.
printer Facility used to print elements, theorypredictions, missing topologies et al in various forms
pyhfInterface Code that delegates the computation of limits and likelihoods to pyhf.
Pythia6Wrapper Wrapper for pythia6.
pythia8Wrapper Wrapper for pythia8.
 
r
reweighting calculate probabilities and relabel branches
runSModelS Main code for running SModelS.
runtime Tools to gather info about the runtime environment, ( nCPUs() ), or obtain file type ( filetype() ). Pointer to model file is also kept here.
 
s
share
    share.__init__ This package is intended to contain additional modules.
    share.models
    share.models.dgmssm
    share.models.idm
    share.models.mssm
    share.models.nmssm
    share.models.SMparticles
simplifiedLikelihoods Code that implements the simplified likelihoods as presented in CMS-NOTE-2017-001, see https://cds.cern.ch/record/2242860. In collaboration with Andy Buckley, Sylvain Fichet and Nickolas Wardle. Simplified likelihoods v2 (JHEP_021P_1018) are partly implemented.
slhaChecks Check SLHA file for integrity.
smodelsLogging Simple code that creates and configures a central logger
smodelsTools Command line program for SModelS tools.
SMparticleDefinitions Defines the SM particles.
stringTools Holds all code snippets that meddle with strings
 
t
theory
    theory.__init__ This Package is intended to contain everything related to theory: * cross section calculation code * sms decomposition code (LHE-based, SLHA-based) * some more tools, e.g. for reading/writing slha files, or particle names
    theory.auxiliaryFunctions
    theory.branch
    theory.clusterTools
    theory.crossSection
    theory.decomposer
    theory.element
    theory.exceptions
    theory.lheReader
    theory.model
    theory.particle
    theory.theoryPrediction
    theory.topology
theoryExceptions Contains exceptions for SModelS's theory package.
theoryPrediction Provides a class to encapsulate the results of the computation of reference cross sections and related functions.
timeOut Facility to implement a time out option when running smodels
toolBox Contains a singleton-like class that keeps track of all external "HEP" tools, such as pythia, nllfast, etc. Used primarily for installation and deployment.
tools
    tools.__init__ This package contains tools for handling results obtained with the main SModelS code.
    tools.asciiGraph
    tools.caching
    tools.colors
    tools.combinations
    tools.coverage
    tools.crashReport
    tools.databaseBrowser
    tools.databaseClient
    tools.databaseServer
    tools.externalPythonTools
    tools.inclusiveObjects
    tools.interactivePlots
    tools.interactivePlotsHelpers
    tools.ioObjects
    tools.lheChecks
    tools.modelTester
    tools.nllFastWrapper
    tools.physicsUnits
    tools.printer
    tools.proxyDBCreator
    tools.pyhfInterface
    tools.pythia6Wrapper
    tools.pythia8particles
    tools.pythia8Wrapper
    tools.reweighting
    tools.runSModelS
    tools.runtime
    tools.simplifiedLikelihoods
    tools.slhaChecks
    tools.smodelsLogging
    tools.smodelsTools
    tools.statistics
    tools.stringTools
    tools.timeOut
    tools.toolBox
    tools.wrapperBase
    tools.xsecComputer
topology Provides a Topology class and a TopologyList collection type.
txnameObj Holds the classes and methods used to read and store the information in the txname.txt files. Also contains the interpolation methods.
 
w
wrapperBase Wrapper code for external tools: base class
 
x
xsecComputer Computation of reference ("theory") production cross sections.