icecube.simprod.util.simprodtray module

Generic SimProd IceTray Execution and Utilities

icecube.simprod.util.simprodtray.RunI3Tray(params, configure_tray, simulationname, stats={}, summaryfile='', summaryin=None, doprintstats=True, inputfilenamelist=None, outputfile='', outputskipkeys=None, outputstreams=[icetray.I3Frame.TrayInfo, icetray.I3Frame.DAQ, icetray.I3Frame.Simulation, icetray.I3Frame('M')], executionmaxcount=None, seed=None, nstreams=None, streamnum=None, usegslrng=False)
Creates an I3Tray. Adds I3SummaryService context, I3RandomService context,

I3Reader module, and I3Writer module. Calls the passed configure_tray function for further tray configuration. Then, executes the tray, writes out summary to file, and prints stats/tray usage.

Parameters:

  • params – (dict) : parameters; forwarded to configure_tray function

  • configure_tray – (function) : the function called to further configure the tray; signature: (tray, params, stats, logger)

  • simulationname – (str) : the name of the simulation, used for logger

  • stats – (dict) : the stats dict

  • summaryfile – (str) : the filename to read/write the summary; if “”, I3SummaryService is not added.

  • summaryin – (I3MapStringDouble) : the I3 summary inputted to I3SummaryService; if None, summary is read in from summaryfile

  • doprintstats – (bool) : toggles whether to write out stats

  • inputfilenamelist – (list) : I3Reader module files; if None, doesn’t add I3Reader

  • outputfile – (str) : I3Writer module file; if “”, doesn’t add I3Writer

  • outputskipkeys – (list) : I3Writer module skipkeys list

  • outputstreams – (list) : I3Writer streams; default OUTPUT_STREAMS

  • executionmaxcount – (int) : I3Tray exection max count; default None

  • seed – (int) : I3RandomService rng seed

  • nstreams – (int) : I3RandomService number of streams

  • streamnum – (int) : I3RandomService stream number

  • usegslrng – (bool) : toggles whether to use I3GSLRandomService or I3SPRNGRandomService for I3RandomService