pelagos_py.steps.input_output.export#

class pelagos_py.steps.input_output.export.ExportStep(name, parameters=None, diagnostics=False, context=None)[source]#

Bases: pelagos_py.steps.base_step.BaseStep

Exports the the data output by the previous step.

Parameters:
  • output_path (str) – Path and file name to output to. The file extension should be included.

  • export_format (str) – Either “netcdf”, “csv”, “hdf5” or “parquet”. Defaults to “netcdf”.

  • compression (int) – zlib compression level for netcdf/hdf5 output: 0 turns compression off, 1 (fastest) to 9 (smallest). Defaults to 4. Ignored for csv/parquet.

Examples

Example usage in a pipeline configuration:

steps:
  - name: Data Export
    parameters:
        output_path: "save/my/data/here.nc"
        export_format: "netcdf"
        compression: 4
generate_diagnostics()[source]#

Generate diagnostics for the export step.