pycif.plugins.datastreams.fields.gridded_NetCDF_inicond — API reference#
Configuration reference: gridded_NetCDF_inicond plugin
- pycif.plugins.datastreams.fields.gridded_NetCDF_inicond.fetch.fetch(ref_dir, ref_file, input_interval, target_dir, tracer=None, component=None)[source]#
Retrieves the required files according to the simulation and the data files available
Args: - ref_dir: directory where the original files are found - ref_file: (template) name of the original files - input_interval: list of two dates: the beginning and end of the simulation - target_dir: directory where the links to the orginal files are created
Returns: - list_dates: a dictionary in which each key leads to a list of intervals
[date_beginning, date_end] so that each interval is covered by one value taken fom the matching file stored in list_files.
- list_files: dictionary in which each key leads to a list of files so that
the list of intervals are covered by the values provided in these files.
- pycif.plugins.datastreams.fields.gridded_NetCDF_inicond.get_domain.get_domain(ref_dir, ref_file, input_interval, target_dir, 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)