pelagos_py.steps.base_qc

pelagos_py.steps.base_qc.REGISTERED_QC

Registry of explicitly registered QC test classes.

pelagos_py.steps.base_qc.flag_cols

Map of QC flag values to colors for diagnostics plotting.

pelagos_py.steps.base_qc.register_qc(cls)

Decorator to mark QC tests that can be accessed by the ApplyQC step.

class pelagos_py.steps.base_qc.BaseQC(data, **kwargs)

Initializes a base class for quality control, to be further tweaked when inherited.

Follow the docstring format below when creating new QC tests.

Target Variable: “Any” or a specific variable names (see impossible_location_test.py) Flag Number: “Any” or a specific ARGO flag number Variables Flagged: “Any” or specific variable names, possibly external to the target variable (see valid_profile_test.py) Your description follows here.

Target Variable: Flag Number: Variables Flagged:

classmethod describe_parameters()

Return a JSON-serialisable description of this QC check’s parameters.

See pelagos_py.utils.parameter_spec.describe().

log(message, console=True)

Log an info-level message with the QC name prefix. console=False keeps it in the log file only.

log_warn(message)

Log a warning-level message with the QC name prefix.

log_progress(iterable=None, *, desc, total=None, unit='it', leave=False)

Wrap a countable loop as a standard pipeline progress bar (see BaseStep.log_progress()).

return_qc()

Representative of QC processing, to be overridden by subclasses.

Returns:

flags – Output QC flags for the data specific to the test.

Return type:

array-like

plot_diagnostics()

Representative of diagnostic plotting (optional).