ValidationSettings Class Reference

Inheritance diagram for ValidationSettings:

Collaboration diagram for ValidationSettings:

Public Member Functions
def	__new__ (cls, name, description, download_files=None, expert_config=None)
def	json_dumps (self)
def	__str__ (self)

Detailed Description

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

Parameters:
    name (str): The unique name that must match the corresponding calibration, not longer than 64 characters.

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

    download_files (list): The names of the files you want downloaded, e.g. mycalibration_stdout. If multiple files of
    the same name are found, all files are downloaded and appended with the folder they were in.

    expert_config (dict): Default expert configuration for this validation script. This is an optional dictionary
        (which must be JSON compliant) of configuration options for validation script.
        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 validation 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 193 of file __init__.py.

Member Function Documentation

__new__()

def __new__	(		cls,
			name,
			description,
			download_files = None,
			expert_config = None
	)

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

Definition at line 214 of file __init__.py.

json_dumps()

def json_dumps

(

self

)

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

Definition at line 238 of file __init__.py.

---

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

• calibration/scripts/prompt/__init__.py