Skip to content

Module local

This IGM module writes 2D field variables defined in the parameter list vars_to_save into the NetCDF output file specified by the parameter output_file (default: output.nc). The saving frequency is determined by the parameter processes.time.save defined in the time module.

This module depends on xarray.

Config Structure

local:
  file_format_list: ['netcdf']
  output_file: output.nc
  vars_to_save:
    - topg
    - usurf
    - thk
    - smb
    - velbar_mag
    - velsurf_mag
    - uvelsurf
    - vvelsurf
    - wvelsurf
  write_ts: True
  output_ts_file: output_ts.nc

Parameters

Name Type Units Description Default Value
file_format_list list dimless List of file formats to be used for output (e.g., ['netcdf','tif']) ['netcdf']
output_file str dimless Output ncdf data file output.nc
vars_to_save list dimless List of variables to be recorded in the ncdf file ['topg', 'usurf', 'thk', 'smb', 'velbar_mag', 'velsurf_mag', 'uvelsurf', 'vvelsurf', 'wvelsurf']
write_ts bool dimless Flag to write time series data True
output_ts_file str dimless Output ncdf time series data file output_ts.nc

Example Usage