roms_tools.Grid.save

Contents

roms_tools.Grid.save#

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

Save the grid information to a 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:

List[Path] – A list of Path objects for the filenames that were saved.

Contents