hepi.spheno

hepi interface to spheno.

SPheno stands for S(upersymmetric) Pheno(menology) find it here https://spheno.hepforge.org/.

Submodules

Package Contents

Classes

Input

Input for computation and scans.

Runner

SPhenoRunner

Functions

update_slha(i)

Updates dependent parameters in Input i.

Attributes

spheno_default_runner

Default SPheno Runner to provide backward compatibility

run

set_path

get_path

class hepi.spheno.Input(order: Order, energy: float, particle1: int, particle2: int, slha: str, pdf_lo: str, pdf_nlo: str, mu_f=1.0, mu_r=1.0, pdfset_lo=0, pdfset_nlo=0, precision=0.01, max_iters=50, invariant_mass='auto', result='total', pt='auto', id='', model='', update=True)

Bases: hepi.util.DictData

Input for computation and scans.

Variables

  • order (Order) – LO, NLO or NLO+NLL computation.

  • energy (int) – CMS energy in GeV.

  • energyhalf (int) – Halfed energy.

  • particle1 (int) – PDG identifier of the first final state particle.

  • particle2 (int) – PDG identifier of the second final state particle.

  • slha (str) – File path of for the base slha. Modified slha files will be used if a scan requires a change of the input.

  • pdf_lo (str) – LO PDF name.

  • pdf_nlo (str) – NLO PDF name.

  • pdfset_lo (int) – LO PDF member/set id.

  • pdfset_nlo (int) – NLO PDF member/set id.

  • pdf_lo_id (int) – LO PDF first member/set id.

  • pdf_nlo_id (int) – NLO PDF first member/set id.

  • mu (double) – central scale factor.

  • mu_f (double) – Factorization scale factor.

  • mu_r (double) – Renormalization scale factor.

  • precision (double) – Desired numerical relative precision.

  • max_iters (int) – Upper limit on integration iterations.

  • invariant_mass (str) – Invariant mass mode ‘auto = sqrt((p1+p2)^2)’ else value.

  • pt (str) – Transverse Momentum mode ‘auto’ or value.

  • result (str) – Result type ‘total’/’pt’/’ptj’/’m’.

  • id (str) – Set an id of this run.

  • model (str) – Path for MadGraph model.

  • update (bool) – Update dependent mu else set to zero.

has_gluino() → bool
has_neutralino() → bool
has_charginos() → bool
has_weakino() → bool
has_squark() → bool
has_slepton() → bool
hepi.spheno.update_slha(i: Input)

Updates dependent parameters in Input i.

Mainly concerns the mu value used by madgraph.

class hepi.spheno.Runner(path: str, in_dir: str = None, out_dir: str = None, pre=None)
orders() → List[hepi.input.Order]

List of supported Orders in this runner.

get_name() → str

Returns the name of the runner.

get_version() → str
_sub_run(coms: List[str]) → str
_check_path() → bool

Checks if the passed path is valid.

_prepare(p: hepi.input.Input, **kwargs) → RunParam
_check_input(param: hepi.input.Input, **kwargs) → bool
_prepare_all(params: List[hepi.input.Input], skip=True, **kwargs) → List[RunParam]
run(params: List[hepi.input.Input], skip=True, parse=True, parallel=True, sleep=0, run=True, ignore_error=False, **kwargs)

Run the passed list of parameters.

Args:

params (list of hepi.Input): All parameters that should be executed/queued. skip (bool): True means stored runs will be skipped. Else the are overwritten. parse (bool): Parse the results.

This is not the prefered cluster/parallel mode, as there the function only queues the job.

parallel (bool): Run jobs in parallel. sleep (int): Sleep seconds after starting job.

run (bool): Actually start/queue runner. ignore_error (bool): Continue instead of raising Exceptions. Also ignores hash collisions.

Returns:

pd.DataFrame : combined dataframe of results and parameters. The dataframe is empty if parse is set to False.

_run(rps: List[RunParam], wait=True, parallel=True, sleep=0, **kwargs)

Runs Runner per RunParams.

Parameters

  • rps (list of RunParams) – Extended run parameters.

  • bar (bool) – Enable info bar.

  • wait (bool) – Wait for parallel runs to finish.

  • sleep (int) – Sleep seconds after starting subprocess.

  • parallel (bool) – Run jobs in parallel.

Returns

return codes from jobs if no_parse is False.

Return type

list of int

_is_valid(file: str, p: hepi.input.Input, d, **kwargs) → bool

Verifies that a file is a complete output.

Parameters

  • file (str) – File path to be parsed.

  • p (hepi.Input) – Onput parameters.

  • d (dict) – Param dictionary.

Returns

True if file could be parsed.

Return type

bool

parse(outputs: List[str]) → List[hepi.results.Result]

Parses Resummino output files and returns List of Results.

Parameters

outputs (list of str) – List of the filenames to be parsed.

Returns

list of hepi.resummino.result.ResumminoResult

_parse_file(file: str) → hepi.results.Result

Extracts results from an output file.

Parameters

file (str) – File path to be parsed.

Returns

If a value is not found in the file None is used.

Return type

Result

get_path() → str

Get the Runner path.

Returns

current Runner path.

Return type

str

get_input_dir() → str

Get the input directory.

Returns

in_dir

Return type

str

get_output_dir() → str

Get the input directory.

Returns

out_dir

Return type

str

get_pre() → str

Gets the command prefix.

Returns

pre

Return type

str

set_path(p: str)

Set the path to the Runner folder containing the binary in ‘./bin’ or ‘./build/bin’.

Parameters

p (str) – new path.

set_input_dir(indir: str)

Sets the input directory.

Parameters

indir (str) – new input directory.

set_output_dir(outdir: str, create: bool = True)

Sets the output directory.

Parameters

outdir (str) – new output directory. create (bool): create directory if not existing.

set_pre(ppre: str)

Sets the command prefix.

Parameters

ppre (str) – new command prefix.

class hepi.spheno.SPhenoRunner(path: str, in_dir: str = None, out_dir: str = None, pre=None)[source]

Bases: hepi.run.Runner

_check_path() → bool

Checks if the passed path is valid.

run(slhas: List[hepi.input.Input], **kwargs) → List[hepi.input.Input]

Run the passed list of parameters for SPheno.

Parameters

slhas (list of Input) – Input parameters with a SLHA file that can be processed by SPheno.

Returns

list of Input

hepi.spheno.spheno_default_runner[source]

Default SPheno Runner to provide backward compatibility

hepi.spheno.run[source]
hepi.spheno.set_path[source]
hepi.spheno.get_path[source]