roms_tools.TidalForcing.save

Contents

roms_tools.TidalForcing.save#

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

Save the tidal forcing information to a NetCDF file.

Parameters:

filepath (Union[str, Path]) – The path or filename where the dataset will be saved. If a directory is specified, the file will be saved with a default name within that directory.
format ({"NETCDF4", "NETCDF3_CLASSIC", "NETCDF3_64BIT_OFFSET", "NETCDF3_64BIT_DATA"}, optional) – NetCDF file format. Defaults to "NETCDF4".

Returns:

Path – A Path object representing the location of the saved file.