roms_tools.RiverForcing.save

RiverForcing.save(filepath: str | Path, format: Literal['NETCDF4', 'NETCDF3_CLASSIC', 'NETCDF3_64BIT_OFFSET', 'NETCDF3_64BIT_DATA'] = 'NETCDF4') → None

Save the river forcing to a NetCDF file.

Parameters:

• filepath (Union[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.