Skip to content
Snippets Groups Projects
Commit 0ec7a0ca authored by Andre Sailer's avatar Andre Sailer
Browse files

Whizard2: setProcessVariables, setSinFile: improve docstrings

parent e23785e5
No related branches found
No related tags found
1 merge request!207Whizard2: interface changes,
Pipeline #407083 passed with stages
in 16 minutes and 6 seconds
......@@ -60,11 +60,18 @@ class Whizard2( LCApplication ):
return S_OK()
def setProcessVariables(self, processes):
""" set the list of processes to simulate
The sindarin will be modified later on to call simulate (list,of,processes)
""" Set the list of processes to simulate
The sindarin file will be modified later on to call **simulate (proc_a, proc_b)**.
The process variables have to be defined in the sindarin file::
process proc_a ...
process proc_b ...
.. versionadded:: v28r0p6
:param processes: which processes to call simulate on, by default 'decay_proc'
:type processes: list, str
:type processes: python:list, str
"""
if isinstance(processes, basestring):
self._decayProc = [proc.strip() for proc in processes.split(',')]
......@@ -81,10 +88,11 @@ class Whizard2( LCApplication ):
Usage:
- Give path to the Whizard2 steering file.
- IMPORTANT: set *seed* via iLCDirac API -> whizard2.setRandomSeed(1)
- IMPORTANT: set *n_events* via iLCDirac API -> whizard2.setNumberOfEvents(100)
- IMPORTANT: set *OutputFile* via iLCDirac API -> whizard2.setOutputFile( outputFilename )
- The variables in which processes are defined which should be simulated can be set via `setProcessVariables`
- IMPORTANT: set **seed** via iLCDirac API -> `Whizard2.setRandomSeed`
- IMPORTANT: set **n_events** via iLCDirac API -> `Whizard2.setNumberOfEvents`
- IMPORTANT: set **OutputFile** via iLCDirac API -> `Whizard2.setOutputFile`
- The variables in which processes are defined which should be simulated can be set
via `Whizard2.setProcessVariables`
:param str whizard2SinFilePath: Path to the whizard2 sin file.
"""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment