cmsHarvester.CMSHarvester Class Reference

CMSHarvester class. More...

Inheritance diagram for cmsHarvester.CMSHarvester:

Public Member Functions
def	__init__
def	cleanup
def	config_file_header
def	db_account_name_cms_cond_dqm_summary
def	db_account_name_cms_cond_globaltag
def	format_conditions_string
def	ident_string
def	option_handler_book_keeping_file
def	option_handler_debug
def	option_handler_force
def	option_handler_frontier_connection
def	option_handler_globaltag
def	option_handler_harvesting_mode
def	option_handler_harvesting_type
def	option_handler_input_Jsonfile
def	option_handler_input_Jsonrunfile
def	option_handler_input_spec
def	option_handler_input_todofile
def	option_handler_no_ref_hists
def	option_handler_quiet
def	option_handler_ref_hist_mapping_file
def	set_output_level
def	time_stamp

Public Attributes
	book_keeping_file_name
	force_running
	frontier_connection_name
	frontier_connection_overridden
	globaltag
	harvesting_info
	harvesting_mode
	harvesting_mode_default
	harvesting_modes
	harvesting_type
	harvesting_types
	input_method
	input_name
	Jsonfilename
	Jsonrunfilename
	log_level
	ref_hist_mappings_file_name
	todofile
	use_ref_hists
	version

Static Public Attributes
list	cmd_line_opts = sys.argv[1:]
tuple	log_formatter = logging.Formatter("%(message)s")
tuple	log_handler = logging.StreamHandler()
tuple	logger = logging.getLogger()

Detailed Description

CMSHarvester class.

Class to perform CMS harvesting.

More documentation `obviously' to follow.

Definition at line 293 of file cmsHarvester.py.

Constructor & Destructor Documentation

def cmsHarvester.CMSHarvester.__init__	(		self,
			cmd_line_opts = None
	)

Definition at line 302 of file cmsHarvester.py.

Member Function Documentation

def cmsHarvester.CMSHarvester.cleanup

(

self

)

Definition at line 506 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.config_file_header

(

self

)

Definition at line 600 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.db_account_name_cms_cond_dqm_summary

(

self

)

See db_account_name_cms_cond_globaltag.

Definition at line 585 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.db_account_name_cms_cond_globaltag

(

self

)

Return the database account name used to store the GlobalTag.

The name of the database account depends (albeit weakly) on
the CMSSW release version.

Definition at line 568 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.format_conditions_string	(		self,
			globaltag
	)

Create the conditions string needed for `cmsDriver'.

Just glueing the FrontierConditions bit in front of it really.

Definition at line 543 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.ident_string

(

self

)

Definition at line 531 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_book_keeping_file	(		self,
			option,
			opt_str,
			value,
			parser
	)

Store the name of the file to be used for book keeping.

The only check done here is that only a single book keeping
file is specified.

Definition at line 960 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_debug	(		self,
			option,
			opt_str,
			value,
			parser
	)

Switch to debug mode.

This both increases the amount of output generated, as well as
changes the format used (more detailed information is given).

Definition at line 658 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_force	(		self,
			option,
			opt_str,
			value,
			parser
	)

Switch on `force mode' in which case we don't brake for nobody.

In so-called `force mode' all sanity checks are performed but
we don't halt on failure. Of course this requires some care
from the user.

Definition at line 694 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_frontier_connection	(		self,
			option,
			opt_str,
			value,
			parser
	)

Override the default Frontier connection string.

Please only use this for testing (e.g. when a test payload has
been inserted into cms_orc_off instead of cms_orc_on).

This method gets called for three different command line
options:
- --frontier-connection,
- --frontier-connection-for-globaltag,
- --frontier-connection-for-refhists.
Appropriate care has to be taken to make sure things are only
specified once.

Definition at line 822 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_globaltag	(		self,
			option,
			opt_str,
			value,
			parser
	)

Set the GlobalTag to be used, overriding our own choices.

By default the cmsHarvester will use the GlobalTag with which
a given dataset was created also for the harvesting. The
--globaltag option is the way to override this behaviour.

Definition at line 787 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_harvesting_mode	(		self,
			option,
			opt_str,
			value,
			parser
	)

Set the harvesting mode to be used.

Single-step harvesting can be used for samples that are
located completely at a single site (= SE). Otherwise use
two-step mode.

Definition at line 754 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_harvesting_type	(		self,
			option,
			opt_str,
			value,
			parser
	)

Set the harvesting type to be used.

This checks that no harvesting type is already set, and sets
the harvesting type to be used to the one specified. If a
harvesting type is already set an exception is thrown. The
same happens when an unknown type is specified.

Definition at line 710 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_input_Jsonfile	(		self,
			option,
			opt_str,
			value,
			parser
	)

Definition at line 910 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_input_Jsonrunfile	(		self,
			option,
			opt_str,
			value,
			parser
	)

Definition at line 917 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_input_spec	(		self,
			option,
			opt_str,
			value,
			parser
	)

TODO TODO TODO
Document this...

Definition at line 924 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_input_todofile	(		self,
			option,
			opt_str,
			value,
			parser
	)

Definition at line 903 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_no_ref_hists	(		self,
			option,
			opt_str,
			value,
			parser
	)

Definition at line 810 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_quiet	(		self,
			option,
			opt_str,
			value,
			parser
	)

Definition at line 685 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.option_handler_ref_hist_mapping_file	(		self,
			option,
			opt_str,
			value,
			parser
	)

Store the name of the file for the ref. histogram mapping.

Definition at line 983 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.set_output_level	(		self,
			output_level
	)

Adjust the level of output generated.

Choices are:
  - normal  : default level of output
  - quiet   : less output than the default
  - verbose : some additional information
  - debug   : lots more information, may be overwhelming

NOTE: The debug option is a bit special in the sense that it
      also modifies the output format.

Definition at line 619 of file cmsHarvester.py.

def cmsHarvester.CMSHarvester.time_stamp

(

self

)

Definition at line 518 of file cmsHarvester.py.

Member Data Documentation

cmsHarvester.CMSHarvester.book_keeping_file_name

Definition at line 974 of file cmsHarvester.py.

list cmsHarvester.CMSHarvester.cmd_line_opts = sys.argv[1:]

static

Definition at line 484 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.force_running

Definition at line 704 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.frontier_connection_name

Definition at line 354 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.frontier_connection_overridden

Definition at line 359 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.globaltag

Definition at line 342 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.harvesting_info

Definition at line 366 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.harvesting_mode

Definition at line 381 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.harvesting_mode_default

Definition at line 385 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.harvesting_modes

Definition at line 328 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.harvesting_type

Definition at line 375 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.harvesting_types

Definition at line 309 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.input_method

Definition at line 392 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.input_name

Definition at line 401 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.Jsonfilename

Definition at line 912 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.Jsonrunfilename

Definition at line 919 of file cmsHarvester.py.

tuple cmsHarvester.CMSHarvester.log_formatter = logging.Formatter("%(message)s")

static

Definition at line 491 of file cmsHarvester.py.

tuple cmsHarvester.CMSHarvester.log_handler = logging.StreamHandler()

static

Definition at line 488 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.log_level

Definition at line 646 of file cmsHarvester.py.

tuple cmsHarvester.CMSHarvester.logger = logging.getLogger()

static

Definition at line 493 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.ref_hist_mappings_file_name

Definition at line 995 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.todofile

Definition at line 905 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.use_ref_hists

Definition at line 346 of file cmsHarvester.py.

cmsHarvester.CMSHarvester.version

Definition at line 305 of file cmsHarvester.py.