| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

NuWa: Index of all Job Modules

Introduction

Job modules are used to configure and run simulation and analysis tasks. They are used with the nuwa.py command as follows:
% nuwa.py -n 100 -m "MDC09a.runLED" -o led_n100.root
This example simulates 100 LED flashes in the center of the AD. The module name is listed in quotes after the '-m' option. The '-n' option specifies the number of events you wish to process, and the '-o' option specifies the output file name. Additional options can be passed directly to the job module by placing them inside the quotes. The following example places the LED along the axis of ACU B, at the z = +100.0 cm position.
% nuwa.py -n 100 -m "MDC09a.runLED -z 100.0 -n DayaBayAD1_ACU_B_GdlsEdge_LED" -o led_n100.root
Analysis jobs are run in the same fashion. The following example runs a simple event reconstruction. The '-n -1' option will process all events in the input file(s).
% nuwa.py -n -1 -m "ReconAlg.AdSimple" -o led_recon_n100.root led_n100.root
Modules may also be run in series:
% nuwa.py -n 100 -m "MDC09a.runLED"-m "ReconAlg.AdSimple" -o led_recon_n100.root

Modifying Modules

To change a module, make a copy in your local directory, change it, and run it without the 'package.' prefix in the module name.
% mkdir mywork
% cd mywork
% cp $PACKAGEROOT/(package)/python/(package)/module.py myModule.py
% (change the module)
% nuwa.py -n 100 -m "myModule" -o myOutput_n100.root

Writing your own Job Module

A job module is a script which configures your simulation or analysis job. It is written in the python programming language. In your module, you must define two functions: configure and run.
def configure( argv=[] ):
    """Write a description of your module here
       
       Add more details about your module here
    """
    # Put your job configuration commands here
    return

def run(app):
    """Additional Run-time configuration can go here"""
    pass
See the many modules below for module configuration examples.
Job ModuleDescriptionPackage
Calibration.ACUNeutronCapturePositionCalibration
Calibration.ACUNeutronCaptureVertexConfigure this module with ACU unitCalibration
ADETWindowTagging.ADETWindowDataADETWindowTagging
ADETWindowTagging.ADETWindowTagADETWindowTagging
AdRec.expcalcAdRec
ADRelEffADRelEff
ADRelEff.runADRelEff
Quickstart.AdScaledExample of reconstructing calibrated data Quickstart
ADSinglesTagging.ADSingleDataConfiguration with command line argumentsADSinglesTagging
ADSinglesTagging.ADSingleTagConfiguration with command line argumentsADSinglesTagging
Quickstart.AdTimeExample of reconstructing calibrated data Quickstart
Quickstart.AdUnfoldRecQuickstart
TargetProtonsSvc.AllDataExampleTargetProtonsSvc
AnalysesEx.RawData2TreeAnalysesEx
AnalysesEx.RecData2TreeAnalysesEx
Quickstart.CalculateCalibStatsGenerate calibrated hit statistics, add to eventQuickstart
CalibAlgConfigure calibration algorithmCalibAlg
CalibEnergyCalibEnergy
CalibParamCalibParam
CalibParam.MakeFineGain1CalibParam
CalibParam.MakeHighGainCalibParam
CalibParam.MakeHighGain1CalibParam
CalibParam.MakePmtTableCalibParam
CalibParam.MakePmtTable1CalibParam
CalibParam.MuonTimingCalculate Muon Pool Timing Calibration Parameters CalibParam
CalibParam.ReprocessCalibParam
Quickstart.CalibrateExample of calibrating raw data Quickstart
UnderstandingEnergy.CalibrationAmCCo60Configure this module with source positionUnderstandingEnergy
UnderstandingEnergy.CalibrationGe68Configure this module with source positionUnderstandingEnergy
CalibrationTagging.ADLEDDataCalibrationTagging
CalibrationTagging.ADLEDTagCalibrationTagging
CalibrationTagging.AmCDataConfiguration with command line argumentsCalibrationTagging
CalibrationTagging.AmCTagConfiguration with command line argumentsCalibrationTagging
CalibrationTagging.Co60DataCalibrationTagging
CalibrationTagging.Co60TagCalibrationTagging
CalibrationTagging.Ge68DataCalibrationTagging
CalibrationTagging.Ge68TagCalibrationTagging
AdBasicFigs.CheckFadcAdBasicFigs
SimSequencer.checkIBDSimSequencer
MDC09a.chkGammaMDC09a
MDC09a.chkIBDMDC09a
MDC09a.chkIBD15MDC09a
MDC09a.chkIBD.AdPerformanceMDC09a
SmartFilter.ClearSmartFilter
ADCoincTagging.CoincidenceLooseTag AD coincidence events ADCoincTagging
ADCoincTagging.CoincidenceTightTag AD coincidence events with tighter cuts and store more user dataADCoincTagging
ConfigurableExample.aConfigurableExample
ConfigurableExample.bConfigurableExample
DaqFormatModules.DaqBenchmarkExample of processing raw data DaqFormatModules
DaqFormatModules.DaqFileWriterExample of processing raw data DaqFormatModules
DaqRunInfoSvc.TestDaqRunInfoSvc
DaqFormatModules.DaqXmlDumpDaqFormatModules
DarkRatesDarkRates
DarkRates.runDarkRates
DataQualityDataQuality
DataQuality.AdCoincidenceDataQuality
DataQuality.AdPlotterDataQuality
DataQuality.ConvertToTreeDataQuality
DataQuality.DiagnosticFigsDataQuality
DataQuality.OnlineOfflineTestDataQuality
DataQuality.OnlineOfflineTestRefactoredDataQuality
DbiDataSvc.TestDbiDataSvcDbiDataSvc
DBWriterDBWriter
DeadTimeDeadTime
DeadTime.runDeadTime
DetHelpers.autoPositionerTestDetHelpers
DetHelpers.det_locateDetHelpers
DetHelpers.positionerTestDetHelpers
DetHelpers.TestCoordSysSvcDetHelpers
DetLatencyDetLatency
DetLatency.runDetLatency
DetSim.DefaultDetSim
DetSim.OpStackscript for fast neutron background studyDetSim
DetSim.OptsDetSim
DetSim.SetG4VerbosityDetSim
DetSim.TestFastStackingDetSim
DigitizeAlg.runDigitizeAlg
DigitizeAlg.TestDigitizeAlg
DQDumpPmtTemplate job module DQDump
DQDumpRpcConfigure DQDump
DQMRawData.RunDQMRawData
DQMRawData.runAllDQMRawData
DQMRawData.runCalibDQMRawData
DQMRawData.runDaqDQMRawData
DQMRawData.runReconDQMRawData
DQMRawData.runRpcDQMRawData
Calibration.DrawACUNeutronCapturePositionCalibration
Calibration.DrawACUNeutronCaptureVertexCalibration
UnderstandingEnergy.DrawFigsUnderstandingEnergy
Calibration.DrawGe68EnergyDiffCalibration
Calibration.DrawGe68EnergyGeoCalibration
Calibration.DrawGe68EnergySpecCalibration
Calibration.DrawGe68EnergySubCalibration
Calibration.DrawGe68PositionCalibration
Calibration.DrawReadoutDetectorCalibration
Quickstart.DryRunTablesExample of loading Dry Run cabling and calibration tablesQuickstart
Quickstart.DtDataDtData job module Quickstart
JobInfoSvc.DumpExample module for printing job info JobInfoSvc
Test15.DumpTest15
ElecTutorial.DumpWaveformsConfigure this module with LED positionElecTutorial
DybAlg.DefaultFilterDybAlg
DybAlg.FilterExampleDybAlg
DybAlg.mptDybAlg
DybAlg.ReconFilterDybAlg
DybAlg.TestAbortEventAlgDybAlg
DybAlg.TestLoopMgrDybAlg
DybAlg.TestRandomDybAlg
DybAlg.TestShuffleDybAlg
DybEventMgr.ChunkerDybEventMgr
DybEventMgr.FramerDybEventMgr
DybEventMgr.HybridLoopDybEventMgr
DybEventMgr.OutputHeadersDybEventMgr
DybHelloWorld.OptionalJomDybHelloWorld
DybHelloWorld.PyloWorldDybHelloWorld
DybIO.DaqRootWriterDybIO
DybIO.TestIncidentDybIO
DybIO.TestLoaderDybIO
DybIO.TestRollerDybIO
Quickstart.dybNuWaHistExample of histogramming NuWa data Quickstart
DybPython.TestDecoratorsDybPython
DybPython.TestMod1DybPython
DybPython.TestMod2DybPython
Quickstart.EH1TablesExample of loading EH1 cabling and calibration tablesQuickstart
ElecSim.TestElecSim
ElecSim.ViewerElecSim
UnderstandingEnergy.EnergyStatsUnderstandingEnergy
EvtDspEvtDsp
CalibStats.ExampleGenerate calibrated hit statistics, add to eventCalibStats
DivingIn.ExampleDivingIn
SmartFilter.ExampleSmartFilter
NeutronCapTagging.Exampletagging neutron capture candidates NeutronCapTagging
DivingIn.ExamplePmtIdDivingIn
DivingIn.ExampleTreeDivingIn
DivingIn.Example_GenEventDivingIn
DivingIn.Example_SimEventDivingIn
Quickstart.FMCP11aTablesExample of loading simulation cabling and calibration tablesQuickstart
MuonProphet.FullChainMuonProphet
Calibration.Ge68EnergyStatsCalibration
Calibration.Ge68PositionStatsCalibration
GenDecay.HelpersGenDecay
GenDecay.HistogramGenDecay
ElecTutorial.GenKinematicsConfigure this module with LED positionElecTutorial
GenMuon.HelpersGenMuon
GenMuon.TestHistGenMuon
Quickstart.GenParticleBare Particle GeneratorQuickstart
Test15.GenSimPushTest15
GenTools.histogramsGenTools
GenTools.OptsGenTools
GenTools.TestRockGammaExample of generating rock gamma data GenTools
DetSimValidation.genTreeDetSimValidation
XmlDetDesc.geoXmlDetDesc
LEDGain.getLEDGainTemplate job module LEDGain
TargetProtonsSvc.GetProtonsOverTimeTargetProtonsSvc
InvBetaDecay.HelpersInvBetaDecay
Li9He8Decay.HelpersLi9He8Decay
Historian.GraphMakerHistorian
Quickstart.IBDBoxCutFigsExample of applying a tight IBD box cut Quickstart
Quickstart.IBDBoxCutLooseExample of applying a loose IBD box cut Quickstart
SimpleFilter.InputSimpleFilter
SimpleFilter.KeepSimpleFilter
SmartFilter.KeepSmartFilter
SmartFilter.KeepAdCoincParentsSmartFilter
SmartFilter.KeepAdETWindowCutSmartFilter
SmartFilter.KeepAdScaledSmartFilter
SmartFilter.KeepAdSingleSmartFilter
SmartFilter.KeepCoincidenceTightSmartFilter
SmartFilter.KeepKUPSmartFilter
SmartFilter.KeepOdmDataSmartFilter
SmartFilter.KeepReconSmartFilter
SmartFilter.KeepSpNeutronDataSmartFilter
ADCoincTagging.KeepTightADCoincTagging
Likelihood.runLikelihood
ProcessTools.LoadReadoutEmpty Algorithm which forces loading of Readout ProcessTools
MuonBasicFigs.MakeCalibFigsMake Muon figures from calibrated data MuonBasicFigs
AdBasicFigs.MakeCalibFigsMake AD figures from calibrated data AdBasicFigs
SpallationFigs.MakeFigsGenerate Spallation diagnostic figures SpallationFigs
AdBasicFigs.MakeFigsMake AD figures from raw data AdBasicFigs
FlasherId.MakeFigsMake flasher figures from raw data FlasherId
McTruthFigs.MakeFigsIBDMake MC Truth figures from simulated data McTruthFigs
McTruthFigs.MakeFigsMuonMake MC Truth figures from simulated data McTruthFigs
McTruthFigs.MakeFigsRadMake MC Truth figures from simulated data McTruthFigs
ESCalibSPN.MakeHistogramsTemplate job module ESCalibSPN
AdBasicFigs.MakeReconFigsMake AD figures from reconstructed data AdBasicFigs
MemoryCheckMemoryCheck
StatisticsSvc.MergeStatsStatisticsSvc
Test15.MixItUpTest15
Quickstart.MLReconExample of reconstructing calibrated data Quickstart
Quickstart.MuonCombineExample of reconstructing calibrated data Quickstart
MuonHitSim.runMuonHitSim
MuonSimpleAlg.MuonRecSimpleMuonSimpleAlg
MuonSimpleAlg.testMuonSimpleAlg
MuonSimpleExMuonSimple
MuonTagging.MuonDatamuon data MuonTagging
MuonTagging.MuonTagLoosetagging muon event MuonTagging
MuonTagging.MuonTagTighttagging muon event MuonTagging
MuonTagging.SpallDatatagging muon event MuonTagging
UnderstandingEnergy.NeutronSimConfigure this module with neutron energyUnderstandingEnergy
UnderstandingEnergy.NeutronsInACUConfigure this module with ACU unitUnderstandingEnergy
SpNeutronTagging.NeutronSpLooseDataConfiguration with command line argumentsSpNeutronTagging
SpNeutronTagging.NeutronSpLooseTagConfiguration with command line argumentsSpNeutronTagging
SpNeutronTagging.NeutronSpTightDataConfiguration with command line argumentsSpNeutronTagging
SpNeutronTagging.NeutronSpTightTagConfiguration with command line argumentsSpNeutronTagging
Quickstart.PmtInfoExampleExample of processing raw data Quickstart
DivingIn.PositronSimDivingIn
Quickstart.PrintCalibDataExample of processing calibrated data Quickstart
Quickstart.PrintPMTMapConfiguration with command line argumentsQuickstart
Quickstart.PrintRawDataExample of processing raw data Quickstart
Quickstart.PrintReconDataExample of processing reconstructed data Quickstart
RunDataSvc.PrintRunDataRunDataSvc
KUP11a.prodIHEPKUP11a
P14B.prodIHEPP14B
RandomGainRandomGain
RandomGain.MakeTableRandomGain
Quickstart.RawEventTreeQuickstart
Co60Auto.readCo60dataTemplate job module Co60Auto
Calibration.ReadoutDetectorCalibration
ElecTutorial.ReadoutDumperElecTutorial
ReadoutSim.CheckAlgReadoutSim
ReconAlg.AdExampleReconAlg
ReconAlg.AdScaleExample of reconstructing calibrated data ReconAlg
ReconAlg.AdSimpleReconAlg
ReconAlg.MuonCombineExample of reconstructing calibrated data ReconAlg
ReconAlg.PoolSimpleRecExample of reconstructing calibrated data ReconAlg
ReconAlg.RpcSimpleReconAlg
Quickstart.ReconstructExample of reconstructing calibrated data Quickstart
Quickstart.ReconstructMuonExample of reconstructing calibrated data Quickstart
RollingGainRollingGain
RollingGainAuto.ScanFramesRollingGainAuto
RootIOTest.CheckTimeOrderCheck if events are in orderRootIOTest
RootIOTest.hdrValidRootIOTest
RootIOTest.howBigRootIOTest
RootIOTest.OutputFrobicatorRootIOTest
RootIOTest.TestFileStatSvcRootIOTest
RootIOTest.TestHeaderObjectsRootIOTest
RootIOTest.TestMultiStreamRootIOTest
RootIOTest.TestUserDataRootIOTest
RootIOTest.TestUserDataVectorRootIOTest
RPCCalib.rpccalibToolsRPCCalib
Quickstart.RpcHackFix broken RPC data Quickstart
ReadoutSim.runDarkReadoutSim
ElecTutorial.RunElectronicsConfigure this module with LED positionElecTutorial
MDC09a.runGammaConfigure this module with gamma energyMDC09a
MDC09a.runIBDMDC09a
MDC09a.runIBD15.FullChainMDC09a
ReadoutSim.runLEDReadoutSim
MDC09a.runLEDConfigure this module with LED positionMDC09a
AdRec.runLEDAdRec
CalibAlg.runLEDCalibAlg
MuonRec.runMuonRecExMuonRec
MDC09a.runPositronConfigure this module with positron positionMDC09a
ElecTutorial.RunReadoutsConfigure this module with LED positionElecTutorial
FMCP11a.SandglassFMCP11a
StatisticsSvc.ServerStatisticsSvc
MDC09a.SetCablingSet the FEE/PMT/Hardware cable connections data fileMDC09a
ElecTutorial.share.runDoublePulseElecTutorial
Sim15.anaSim15
Sim15.EffSim15
Sim15.FullChainSimpleSim15
Calibration.SimACUNeutronsConfigure this module with ACU unitCalibration
SimAmC.ACUAmCConfigure this module with ACU unitSimAmC
SimAmC.AddStrongAmCSimAmC
SimAmC.StrongAmCConfigure this module with source positionSimAmC
SimAmC.ValidateAmCMCConfigure this module with ACU unitSimAmC
Calibration.SimGe68noGEOConfigure this module with source positionCalibration
Calibration.SimGe68wBGConfigure this module with source positionCalibration
Calibration.SimGe68wBGnoSRCConfigure this module with source positionCalibration
Calibration.SimGe68wGEOConfigure this module with source positionCalibration
SimMCS.simPuCConfigure this module with ACU unitSimMCS
SimMCS.simPuCCo60Configure this module with ACU unitSimMCS
SimMCS.simPuCCo60McsConfigure this module with ACU unitSimMCS
SimMCS.simPuCMcsConfigure this module with ACU unitSimMCS
SimSequencer.RunIBDSimSequencer
SimSequencer.RunSimSeqConfigure this module with LED positionSimSequencer
Quickstart.SimulationTablesExample of loading simulation cabling and calibration tablesQuickstart
SpadeSvcConfigures this moduleSpadeSvc
Stage.FullChainStage
Stage.TestStage
Tagger.CalibStatsTagger
Tagger.CoincTagger.ADCoincDataConfiguration with command line argumentsTagger
Tagger.CoincTagger.ADCoincTagConfiguration with command line argumentsTagger
Tagger.ETWindowTagger.ADETWindowDataConfiguration with command line argumentsTagger
Tagger.ETWindowTagger.ADETWindowTagConfiguration with command line argumentsTagger
Tagger.ETWindowTagger.mlRecADETWindowDataConfiguration with command line argumentsTagger
Tagger.ETWindowTagger.mlRecADETWindowTagConfiguration with command line argumentsTagger
Tagger.Filters.ADRoughCoincTagConfiguration with command line argumentsTagger
Tagger.MuonTagger.MuonTagConfiguration with command line argumentsTagger
Tagger.MuonTagger.SpallB12Configuration with command line argumentsTagger
Tagger.MuonTagger.SpallDataConfiguration with command line argumentsTagger
Tagger.SingleTagger.ADSingleDataConfiguration with command line argumentsTagger
Tagger.SingleTagger.ADSingleTagConfiguration with command line argumentsTagger
Tagger.SpecialEventsConfiguration with command line argumentsTagger
TaggingExample.ADCalibDataTaggingExample
TaggingExample.ADChannelDataTaggingExample
TaggingExample.ADReadoutDataTaggingExample
TaggingExample.ADRecDataTaggingExample
TaggingExample.CoincDataTaggingExample
TaggingExample.CoincTagConfiguration with command line argumentsTaggingExample
TaggingExample.DetectorTagTaggingExample
TaggingExample.GenDataTaggingExample
TaggingExample.SimDataTaggingExample
Quickstart.TemplateTemplate job module Quickstart
TESDemoTESDemo
ADCoincTagging.TestCoincConfigure coincidence testing algorithm ADCoincTagging
DataSvc.TestDaqDetailsDataSvc
RunDiagnostics.TesterRunDiagnostics
ReadoutSim.TestRPCsimReadoutSim
TargetProtonsSvc.TestTargetProtonsSvcTargetProtonsSvc
TrigSim.gammaESumConfigure this module with gamma energyTrigSim
UserTagging.UserData.ADCalibDataUserTagging
UserTagging.UserData.ADChannelDataUserTagging
UserTagging.UserData.ADReadoutDataUserTagging
UserTagging.UserData.ADRecDataUserTagging
UserTagging.UserData.CoincDataUserTagging
UserTagging.UserData.GenDataUserTagging
UserTagging.UserData.SimDataUserTagging
UserTagging.UserTag.CoincTagConfiguration with command line argumentsUserTagging
UserTagging.UserTag.DetectorTagUserTagging
UserTagging.UserTag.DetTagUserTagging
DivingIn.ViktorsTestDivingIn
ElecTutorial.WaveDumperElecTutorial
XmlDetDesc.dump_geoXmlDetDesc
XmlDetDesc.MCSXmlDetDesc
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |