pycif.plugins.datastreams.fluxes.unstructured_NetCDF — API reference

pycif.plugins.datastreams.fluxes.unstructured_NetCDF — API reference#

Configuration reference: unstructured_NetCDF plugin

pycif.plugins.datastreams.fluxes.unstructured_NetCDF.get_domain.get_domain(ref_dir, ref_file, input_interval=None, target_dir=None, tracer=None)[source]#

Read information from the reference file to define the data horizontal and, if relevant, vertical domain.

Parameters:

  • ref_dir (str) – the path to the input files

  • ref_file (str) – format of the input files

  • input_interval (list) – simulation interval (start and end dates)

  • target_dir (str) – where to copy

  • tracer – the tracer Plugin

Returns:

a domain class object, with the definition of the center grid cells coordinates, as well as corners

Return type:

domain (Domain)

pycif.plugins.datastreams.fluxes.unstructured_NetCDF.read.read(self, name, varnames, dates, files, interpol_flx=False, tracer=None, model=None, ddi=None, debug_read=False, **kwargs)[source]#
pycif.plugins.datastreams.fluxes.unstructured_NetCDF.write.write(self, name, flx_file, flx, mode='a', metadata=None, **kwargs)[source]#