roms_tools.CDRForcing.save

roms_tools.CDRForcing.save#

CDRForcing.save(filepath: str | Path, format: Literal['NETCDF4', 'NETCDF3_CLASSIC', 'NETCDF3_64BIT_OFFSET', 'NETCDF3_64BIT_DATA'] = 'NETCDF4') list[Path]#

Save the volume source with tracers to a NetCDF file.

Parameters:
  • filepath (str | Path) – The base path and filename for the output files.

  • format ({"NETCDF4", "NETCDF3_CLASSIC", "NETCDF3_64BIT_OFFSET", "NETCDF3_64BIT_DATA"}, optional) – NetCDF file format. Defaults to "NETCDF4".

Returns:

list[Path] – A list of Path objects for the saved files. Each element in the list corresponds to a file that was saved.