SimProd

Mini framework to send LHCb simulation jobs on a batch system (HTCondor, Slurm)!

A LHCb mattermost channel called SimProd is available for discussing any issues.

Installation

To install the module do

python setup.py install --user

You will be asked to enter some directories where you want to find your simulated samples.

Dependencies:

IPython
TinyDB
UltraJSON (Optionnal, Recommended)
setuptools (Optionnal, Recommended)

Usage

To launch the module just type simprod.

You need to to know:

the EvtType of the process you want to generate (DecFiles webpage)
Year of data taking to simulate (Run I: 2011, 2012, Run II: 2015, 2016, 2017, 2018)
Number of events you want to produce.

Description of simulation setups can be found here. To start a new simulation job do:

j = SimulationJob( evttype=EVTTYPE, year=YEAR, nevents=NEVENTS)
j.prepare()
j.send()

Options

Your have other options by default that you can change:

j.polarity: Magnet conditions to simulate [MagUp or MagDown, default: half MagUp, half MagDown].
j.neventsjob: Number of events per jobs [default: 50].
j.runnumber: Run number for simulation in Gauss.
j.simcond: Simulation condition [Sim09b, Sim09c, Sim09e, Sim09g, Sim09h default: Sim09h].
j.stripping: Version of the stripping (default = '').
j.turbo: Run the Turbo step.
j.mudst: Produce a muDST output.
j.decfiles: Version of the DecFiles package (default = v30r46).
j.infiles: External files to provide for generation (for example LHE or HepMC files).
j.cpu: Number of CPU memory (in MB) per simulation job.
j.keeplogs: keeps the log files even if the jobs is marked as completed (default = True).
j.keepxmls: keeps the generator log xml files (default = True).
j.redecay: use redecay at generation (default = False).
j.simmodel: "pythia8" or "BcVegPy" (default = "pythia8").

These argument are also available at instantiation of a SimulationJob but also as property, i.e:

j = SimulationJob(evttype=EVTTYPE, year=YEAR, nevents=NEVENTS, neventsjob=NEVENTSJOB)

is equivalent to

j = SimulationJob(evttype=EVTTYPE, year=YEAR, nevents=NEVENTS)
j.neventsjob = NEVENTSJOB

you can also modify options for the scheduler you are using through

j.deliveryclerk

HTCondor options

Options for htcondor batch system:

j.deliveryclerk.jobflavour: flavour of a job correspoinding to a maximum runtime (default = "workday").

The available job flavours are as follows:

    espresso     = 20 minutes
    microcentury = 1 hour
    longlunch    = 2 hours
    workday      = 8 hours
    tomorrow     = 1 day
    testmatch    = 3 days
    nextweek     = 1 week

Slurm options

Options for slurm batch system with default values designed for EPFL usage:

j.deliveryclerk.time: Maximum running time per simulation job in hours.
j.deliveryclerk.nsimjobs: Maximum number of simultaneous simulation jobs running.
j.deliveryclerk.nsimuserjobs: Maximum number of simultaneous simulation jobs running for the user.
j.deliveryclerk.nuserjobs: Maximum number of simultaneous jobs running for the user.
j.deliveryclerk.npendingjobs: Maximum number of pending jobs for the user.
j.deliveryclerk.nfreenodes: Number of nodes to be free of user's simulation jobs.
j.deliveryclerk.subtime: Time interval when the jobs are sent (e.g. 16 18 means from 4pm to 6pm).

If using the EPFL cluster, please avoid using these options, a configuration file is read with agreed values for these options.

PySlurm can be installed for faster monitoring of the jobs.

Monitoring

Just after the lauching the program type jobs and you can see the status of submitted jobs:

Resend failed subjobs

Use the SimulationJob method send:

jobs[JOBNUMBER].send()

This will send only unsubmitted and failed jobs.

Kill a subjob

jobs[JOBNUMBER][SUBJOBNUMBER].kill()

Remove jobs from the collection

If you wish to remove a job from the jobs container do

jobs[JOBNUMBER].remove()

and the simulation job will not be seen anymore when typing jobs. Note that if subjobs are still running they will be killed.

If you wish to remove only completed jobs do

for j in jobs.select("completed"):
    j.remove()

The log files are also with removed with the job.

Evttypes

For generation Gauss needs an option file callled EVTTYPE.py which is stored in a folder called Evttypes. In you need to modify your option file prior to submission you can type in the simprod prompt

getevttype(EVTTYPE)

and all option files related to this EVTTYPE should be downloaded into the Evttypes directory.

Contributing

Feel free to contribute by the mean of Pull Requests.

leoredi/SimProd