contur.run package

Top level module for running contur. Submodules accessed directly from executable scripts in $CONTUR_ROOT/bin.

Submodules

contur.run.run_analysis module

Main module for running contur on a single yoda file or a parameter grid of yodafiles

contur.run.run_analysis.analyse_grid(scan_paths, conturDepot, args)[source]

perform the analysis on a grid (called by process_grid) and store results in the depot

contur.run.run_analysis.doc_argparser()[source]

wrap the arg parser for the documentation pages

contur.run.run_analysis.main(args)[source]

Main programme to run contur analysis on a grid of yoda files, a single yoda, or a yoda stream.

contur.run.run_analysis.process_grid(args, pool=None, mergedDirs=[])[source]

process the grid, creating a depot and calling analyse_grid for each beam.

contur.run.run_batch_submit module

Main module for building and submitting event generator jobs to a batch farm based on a parameter grid.

contur.run.run_batch_submit.batch_submit(args)[source]

Build event generator jobs for a parameter scan and submit shell scripts to batch

contur.run.run_batch_submit.batch_submit_analyse(args)[source]

Run contur analysis on existing grid, via a batch system

contur.run.run_batch_submit.doc_argparser()[source]

wrap the arg parser for the documentation pages

contur.run.run_batch_submit.gen_analyse_batch_command(grid_name, directory_name, args, setup_commands, job_counter)[source]

Generate commands to write to batch file for a grid analysis job.

Parameters
  • grid_name – the (relative) name of the directory containing the grid.

  • directory_name – the (relative) name of the output directory

  • args – command line arguments.

  • setup_commands – the commands read from the param file to set up the genertor. If not present, may be taken from the environment.

  • job_counter – integer just keeping track of how many jobs in this run.

contur.run.run_batch_submit.gen_batch_command(directory_name, directory_path, args, setup_commands, runbeam='13TeV')[source]

Generate the shell commands to write to the batch file for submitting an event generation job

Parameters
  • directory_name – name of the directory (without any path) in the which batch job will run (usual 4 integers eg 0123

  • directory_path – full, absolute path to the directory in which the batch job will run.

  • args – command line arugments

  • setup_commands – the commands read from the param file to set up the genertor. If not present, may be taken from the environment.

  • runbeam – the collider beam being run. (should be in contur.data.static_db.known_beams, though this is not currently checked.)

contur.run.run_batch_submit.gen_herwig_commands(directory_name, run_info, pipe_hepmc, seed, num_events, runbeam)[source]

Generate the (shell) commands needed to run the herwig event generator.

Parameters
  • directory_name – name of the directory (without any path) in the which batch job will run (usual 4 integers eg 0123

  • run_info – the local runinfo directory name

  • pipe_hepmc – if True pipe the hepmc events to rivet. Otherwise use the native Herwig interface.

  • seed – random number seed for Herwig

  • num_events – number of events to generate

  • runbeam – the collider beam being run. (should be in contur.data.static_db.known_beams, though this is not currently checked.)

contur.run.run_batch_submit.gen_madgraph_commands(directory_name, run_info, pipe_hepmc, seed, num_events, runbeam)[source]

Generate the (shell) commands needed to run the madgraph event generator.

Parameters
  • directory_name – name of the directory (without any path) in the which batch job will run (usual 4 integers eg 0123

  • run_info – the local runinfo directory name

  • pipe_hepmc – if True pipe the hepmc events to rivet.

  • seed – random number seed for Herwig

  • num_events – number of events to generate

  • runbeam – the collider beam being run. (should be in contur.data.static_db.known_beams, though this is not currently checked.)

contur.run.run_batch_submit.gen_pbzpwp_commands(directory_name, run_info, num_events, runbeam)[source]

Generate the (shell) commands needed to run the powheg zpwp event generator.

Parameters
  • directory_name – name of the directory (without any path) in the which batch job will run (usual 4 integers eg 0123

  • run_info – the local runinfo directory name

  • num_events – number of events to generate

  • runbeam – the collider beam being run. (should be in contur.data.static_db.known_beams, though this is not currently checked.)

contur.run.run_batch_submit.gen_pbzpwppy8_commands(directory_name, run_info, num_events, runbeam)[source]

Generate the (shell) commands needed to run the powheg zpwp event generator with pythia8

Parameters
  • directory_name – name of the directory (without any path) in the which batch job will run (usual 4 integers eg 0123

  • run_info – the local runinfo directory name

  • num_events – number of events to generate

  • runbeam – the collider beam being run. (should be in contur.data.static_db.known_beams, though this is not currently checked.)

contur.run.run_batch_submit.gen_submit_command(queue, wallTime=None, memory=None)[source]

Generate the appropriate batch submission command. :param queue: the queue or partition name to submit to.

contur.run.run_batch_submit.get_valid_job_lists(grid_name, num_points)[source]

find the valid yoda files in a given grid and return the as a List strings, with each string contain up to num_points file names of the same beam type.

contur.run.run_grid_tools module

Perform various manipulations on an existing contur scan grid or grids, but NOT the actual contur statistical analysis.

contur.run.run_grid_tools.doc_argparser()[source]

wrap the arg parser for the documentation pages

contur.run.run_grid_tools.main(args)[source]

contur.run.run_plot module

Making plots out of map files

contur.run.run_plot.doc_argparser()[source]

wrap the arg parser for the documentation pages

contur.run.run_plot.load_external_function(file_name)[source]

Load exteral functions for plotting additonal contours, from command line.

Parameters

file_name – the name of the file containing the functions, with or without a .py extension. can be specified with a (rel or abs) path, otherwise with be assumed to be in the current working directory.

contur.run.run_plot.main(args)[source]

Main method Executable to make contur/contour plots from map files.

Module contents