CalibrationSettings Class Reference

Inheritance diagram for CalibrationSettings:

Collaboration diagram for CalibrationSettings:

Public Member Functions
def	__new__ (cls, name, expert_username, description, input_data_formats=None, input_data_names=None, depends_on=None, expert_config=None)
def	json_dumps (self)
def	__str__ (self)

Static Public Attributes
	allowed_data_formats = frozenset({"raw", "cdst", "mdst", "udst"})
	Allowed data file formats. More...

Detailed Description

Simple class to hold and display required information for a prompt calibration script (process).

Parameters:
    name (str): The unique calibration name, not longer than 64 characters.

    expert_username (str): The JIRA username of the expert to contact about this script.
        This username will be used to assign the default responsible person for submitting and checking prompt
        calibration jobs.

    description (str): Long form description of the calibration and what it does. Feel free to make this as long as you need.

    input_data_formats (frozenset(str)): The data formats {'raw', 'cdst', 'mdst', 'udst'} of the input files
        that should be used as input to the process. Used to figure out if this calibration should occur
        before the relevant data production e.g. before cDST files are created.

    input_data_names (frozenset(str)): The names that you will use when accessing the input data given to the
        prompt calibration process i.e. Use these in the ``get_calibrations`` function to access the correct input
        data files.

    depends_on list(CalibrationSettings): The settings variables of the other prompt calibrations that you want
        want to depend on. This will allow the external automatic system to understand the overall ordering of
        scripts to run. If you encounter an import error when trying to run your prompt calibration script, it is
        likely that you have introduced a circular dependency.

    expert_config (dict): Default expert configuration for this calibration script. This is an optional dictionary
        (which must be JSON compliant) of configuration options for your get_calibrations(...) function.
        This is supposed to be used as a catch-all place to send in options for your calibration setup. For example,
        you may want to have an optional list of IoV boundaries so that your prompt script knows that it should split the
        input data between different IoV ranges. Or you might want to send if options like the maximum events per
        input file to process. The value in your settings object will be the *default*, but you can override the value via
        the caf_config.json sent into ``b2caf-prompt-run``.

Definition at line 14 of file __init__.py.

Member Function Documentation

__new__()

def __new__	(		cls,
			name,
			expert_username,
			description,
			input_data_formats = None,
			input_data_names = None,
			depends_on = None,
			expert_config = None
	)

The special method to create the tuple instance. Returning the instance
calls the __init__ method

Definition at line 54 of file __init__.py.

    def __new__(cls, name, expert_username, description,
                input_data_formats=None, input_data_names=None, depends_on=None, expert_config=None):
        """
        The special method to create the tuple instance. Returning the instance
        calls the __init__ method
        """
        if len(name) > 64:
            raise ValueError("name cannot be longer than 64 characters!")
        if not input_data_formats:
            raise ValueError("You must specify at least one input data format")
        input_data_formats = frozenset(map(lambda x: x.lower(), input_data_formats))
        if input_data_formats.difference(cls.allowed_data_formats):
            raise ValueError("There was a data format that is not in the allowed_data_formats attribute.")
        if not input_data_names:
            raise ValueError("You must specify at least one input data name")
        input_data_names = frozenset(input_data_names)
 
        if expert_config:
            # Check that it's a dictionary and not some other valid JSON object
            if not isinstance(expert_config, dict):
                raise TypeError("expert_config must be a dictionary")
            # Check if it is JSONable since people might put objects in there by mistake
            try:
                json.dumps(expert_config)
            except TypeError as e:
                basf2.B2ERROR("expert_config could not be serialised to JSON. "
                              "Most likely you used a non-supported type e.g. datetime.")
                raise e
        else:
            expert_config = {}
 
        if depends_on:
            for calibration_settings in depends_on:
                if not isinstance(calibration_settings, cls):
                    raise TypeError(f"A list of {str(cls)} object is required when setting the 'depends_on' keyword.")
        else:
            depends_on = []
 
        return super().__new__(cls, name, expert_username, description,
                               input_data_formats, input_data_names, depends_on, expert_config)
 

json_dumps()

def json_dumps

(

self

)

Returns:
     str: A valid JSON format string of the attributes.

Definition at line 95 of file __init__.py.

Member Data Documentation

allowed_data_formats

allowed_data_formats = frozenset({"raw", "cdst", "mdst", "udst"})

static

Allowed data file formats.

You should use these values for CalibrationSettings.input_data_formats. Right now you should only use "raw" or "cdst" because we don't actually run calibrations on "mdst" or "udst". They are here for completeness.

Definition at line 52 of file __init__.py.

---

The documentation for this class was generated from the following file:

• calibration/scripts/prompt/__init__.py