Python Module Index

a | b | c | d | e | f | g | i | l | m | n | p | r | s | t | w | x
 
a
analysesCombinations a module with the methods required for computing the likelihood and upper limits for a combination of theory predictions (analyses combination). Mostly used by the TheoryPredictionsCombiner class.
asciiGraph Contains a simple routine to draw ASCII-art Feynman-like graphs.
 
b
base
    base.__init__ This Package is intended to contain base classes and methods used by other packages.
    base.crossSection
    base.exceptions
    base.genericSMS
    base.inclusiveObjects
    base.lheReader
    base.model
    base.particle
    base.particleNode
    base.physicsUnits
    base.runtime
    base.smodelsLogging
baseExceptions Contains exceptions for SModelS's base packages.
basicPrinter Base class for defining printer classes
basicStats a module thats collects various statistical codes, that are shared among other submodules.
 
c
caching The memoize technique, for caching.
clusterTools Module holding the SMSCluster class and cluster methods used to combine similar SMS according to the analysis.
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.
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.
decomposition
    decomposition.__init__ This Package is intended to contain everything related to the decomposition of BSM models: * Model class * Cross-section objects * SMS decomposition code (LHE-based, SLHA-based) * some more tools
    decomposition.decomposer
    decomposition.exceptions
    decomposition.theorySMS
    decomposition.topologyDict
decompositionExceptions Contains exceptions for SModelS's theory package.
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
expAuxiliaryFunctions A collection of functions used to evaluate fuzzy the conditions.
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.expAuxiliaryFuncs
    experiment.expResultObj
    experiment.expSMS
    experiment.expSMSDict
    experiment.graphMatching
    experiment.infoObj
    experiment.metaObj
    experiment.reweighting
    experiment.txnameDataObj
    experiment.txnameObj
experimentExceptions Contains exceptions for SModelS's experiment package.
expResultObj Contains class that encapsulates an experimental result
expSMS This is a class for describing Simplified Model Topologies used for describing experimental results BSM models.
expSMSDict A two-way dictionary containing the links between the (TxName, smsLabel) and the unique ExpSMS objects. It can be used to quickly map the the TxName to the list of unique SMS and vice-versa.
externalPythonTools This module is to check the installation of python tools, i.e. unum, scipy, numpy, pyslha.
 
f
finalStateParticles Defines the final state particles used in the experimental results. It also makes use of the particles defined in smodels.share.models.SMparticles.py
 
g
genericSMS This is a base class for describing Simplified Model Topologies using a rooted tree syntax.
graphMatching A collection of functions to compute the matching between graphs
 
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.
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
masterPrinter Class to handle the distinct printer formats
matcher
    matcher.__init__ This Package is intended to contain everything related to matching decomposition SMS to the database
matcherAuxiliaryFunctions A collection of functions used to evaluate fuzzy the conditions.
matching
    matching.clusterTools
    matching.exceptions
    matching.matcherAuxiliaryFuncs
    matching.modelTester
    matching.theoryPrediction
matchingExceptions Contains exceptions for SModelS's theory package.
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 decomposition, 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.
pythonPrinter Class for decribing a printer in python format
 
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. Simplified likelihoods v2 (arXiv:1809.05548) are partly implemented.
slhaChecks Check SLHA file for integrity.
slhaPrinter Class for decribing a printer in SLHA format
smodelsLogging Simple code that creates and configures a central logger
smodelsTools Command line program for SModelS tools.
SMparticleDefinitions Defines the SM particles.
statistics
    statistics.__init__ This package contains tools for statistical calculations
    statistics.analysesCombinations
    statistics.basicStats
    statistics.exceptions
    statistics.pyhfInterface
    statistics.simplifiedLikelihoods
    statistics.statsTools
    statistics.truncatedGaussians
statsExceptions Contains exceptions for SModelS's statistics package.
statsTools a module that contains the class responsible for all statistical computations. Designed to eventually become simply a frontend for spey
summaryPrinter Class for decribing a summary printer in text format.
 
t
theoryPrediction Provides a class to encapsulate the results of the computation of reference cross sections and related functions.
theorySMS This is a class for describing Simplified Model Topologies used for decomposing BSM models.
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.coverage
    tools.crashReport
    tools.databaseBrowser
    tools.databaseClient
    tools.databaseServer
    tools.externalPythonTools
    tools.ioObjects
    tools.lheChecks
    tools.nllFastWrapper
    tools.printers
    tools.printers.__init__ This package contains tools for handling printers
    tools.printers.basicPrinter
    tools.printers.masterPrinter
    tools.printers.pythonPrinter
    tools.printers.slhaPrinter
    tools.printers.summaryPrinter
    tools.printers.txtPrinter
    tools.printers.xmlPrinter
    tools.printerTools
    tools.pythia6Wrapper
    tools.pythia8particles
    tools.pythia8Wrapper
    tools.runSModelS
    tools.slhaChecks
    tools.smodelsTools
    tools.timeOut
    tools.toolBox
    tools.wrapperBase
    tools.xsecBase
    tools.xsecComputer
    tools.xsecResummino
topology Provides a Topology class and a TopologyList collection type.
tree Classes used to construct trees (root directed graphs) describing simplified model topologies.
truncatedGaussian a module that contains the code that computes an approximate Gaussian likelihood from an expected an observer upper limit. See https://arxiv.org/abs/1202.3415.
txnameDataObj Holds the classes to interpolate the data grid.
txnameObj Holds the class for storing the simplified model information and data for experimental results.
txtPrinter Class for defining a log (stdout) printer
 
w
wrapperBase Wrapper code for external tools: base class
 
x
xmlPrinter Class for decribing a printer in XML format
xsecBasis Computation of reference ("theory") production cross sections.
xsecComputer Computation of reference ("theory") production cross sections.
xsecResummino Computation of reference ("theory") production cross sections.