src.toolbox.steps.custom.load_data#

Attributes#

Classes#

LoadOG1

Initialises the LoadOG1 step.

Module Contents#

src.toolbox.steps.custom.load_data.MIN_YEAR_FILTER = '1990-01-01'[source]#
class src.toolbox.steps.custom.load_data.LoadOG1(filter_bad_time=True, data_start=None, data_end=None, *args, **kwargs)[source]#

Bases: toolbox.steps.base_step.BaseStep

Initialises the LoadOG1 step.

Parameters:
  • filter_bad_time (bool, optional) – If True (default), REMOVES all timestamps outside the expected time window.

  • data_start (str or np.datetime64, optional) – The minimum valid timestamp for the data. If not provided, the filter defaults to the DEPLOYMENT_TIME found in the dataset, or 1990-01-01T00:00:00 if no deployment time is found.

  • data_end (str or np.datetime64, optional) – The maximum valid timestamp for the data. If not provided, it defaults to the current system time when the pipeline is run.

  • configuration (Example usage in a pipeline)

  • steps

    • name: Load OG1 parameters:

      file_path: “/path/to/your/dataset.nc” filter_bad_time: false data_start: “2023-05-01T00:00:00” data_end: “2024-05-01T00:00:00”

step_name = 'Load OG1'[source]#
required_variables = [][source]#
provided_variables = ['TIME', 'LATITUDE', 'LONGITUDE', 'PRES', 'TEMP', 'CNDC'][source]#
filter_bad_time = True[source]#
data_start = None[source]#
data_end = None[source]#
run()[source]#
generate_diagnostics()[source]#