The dataout module.

This module implements functions to perform various output tasks for monc_utils.

Detailed Module Contents

The entire module is documented below.

Created on Mon Aug 2 12:02:20 2021.

@author: Peter Clark and Todd Jones

monc_utils.io.dataout.save_field(dataset, field, write_to_file=True)

Save dask-chunked xarray field to xarray Dataset.

Parameters:

  • dataset (xarray Dataset) – Output dataset.

  • field (dask-chunked xarray) – Input field.

  • write_to_file (bool, optional) – DESCRIPTION. The default is True.

Return type:

None.

monc_utils.io.dataout.setup_child_file(source_file, destdir, outtag, options=None, override=False, keep_coords=None)

Create NetCDF dataset for derived data in destdir.

File name is original file name concatenated with filter_def.id.

Parameters:

  • source_file (str) – Input NetCDF file name.

  • destdir (str) – Output directory.

  • options (dict) – Options dictionary

  • override=False (bool) – if True force creation of file

  • keep_coords=None (dict | None) – coordinates to use for child file

Returns:

  • do (dict) – {‘file’: derived_dataset_name (str) - file name,

    ’ds’: derived_dataset (xarray Dataset) - NetCDF dataset for derived data}

  • exists (bool) – True when input source_file already existed and was not overwritten

Created on Mon Aug 2 11:21:15 2021

@author: Peter Clark