roms_tools.InitialConditions.save

roms_tools.InitialConditions.save#

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

Save the initial conditions information to one NetCDF file.

Parameters:

  • filepath (Union[str, Path]) – The base path or filename where the dataset should be saved.

  • 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.