GOT

  • Reads files for Richard Ray’s Goddard Ocean Tide (GOT) models

    • GOT-ascii

    • GOT-netcdf

Calling Sequence

import pyTMD.io
ds = pyTMD.io.GOT.open_mfdataset(model_files, group='z', format=format)

Source code

pyTMD.io.GOT.open_mfdataset(model_files: list[str] | list[Path], parallel: bool = False, **kwargs)[source]

Open multiple GOT model files

Parameters:
model_files: list of str or pathlib.Path

List of OTIS model files

parallel: bool, default False

Open files in parallel using dask.delayed

kwargs: dict

Additional keyword arguments for opening GOT files

Returns:
ds: xarray.Dataset

GOT tide model data

pyTMD.io.GOT.open_got_dataset(input_file: str | Path, **kwargs)[source]

Open GOT-formatted model files

Parameters:
input_file: str or pathlib.Path

Input transport file

format: str, default ‘netcdf’

Model format

  • 'ascii': traditional GOT ASCII format

  • 'netcdf': GOT netCDF4 format

kwargs: dict

Additional keyword arguments for opening GOT files

Returns:
ds: xarray.Dataset

GOT tide model data

pyTMD.io.GOT.open_got_ascii(input_file: str | Path, chunks: int | dict | str | None = None, **kwargs)[source]

Open GOT-formatted ASCII files

Parameters:
input_file: str or pathlib.Path

Model file

chunks: int, dict, str, or None, default None

Coerce output to specified chunks

compressed: bool, default False

Input file is gzip compressed

Returns:
ds: xarray.Dataset

GOT tide model data

pyTMD.io.GOT.open_got_netcdf(input_file: str | Path, chunks: int | dict | str | None = None, **kwargs)[source]

Open GOT-formatted netCDF4 files

Parameters:
input_file: str or pathlib.Path

Model file

chunks: int, dict, str, or None, default None

Variable chunk sizes for dask (see xarray.open_dataset)

compressed: bool, default False

Input file is gzip compressed

Returns:
ds: xarray.Dataset

GOT tide model data

class pyTMD.io.GOT.GOTDataset(ds)[source]

xarray.Dataset utilities for GOT tidal models

to_ascii(path: str | Path, fill_value: float = 999.0, mode: str = 'w', **kwargs)[source]

Writes tidal constituents to ASCII files in GOT format

Parameters:
path: str | pathlib.Path

Output directory for ASCII files

fill_value: float, default -999.0

Fill value for missing data

mode: str, default ‘w’

File mode

kwargs: dict

Additional keyword arguments for ASCII writer

to_netcdf(path: str | Path, mode: str = 'w', encoding: dict = {'complevel': 9, 'zlib': True}, **kwargs)[source]

Writes tidal constituents to netCDF4 files in GOT format

Parameters:
path: str | pathlib.Path

Output directory for netCDF4 files

mode: str, default ‘w’

netCDF4 file mode

encoding: dict, default {“zlib”: True, “complevel”: 9}

netCDF4 variable compression settings

kwargs: dict

Additional keyword arguments for xarray netCDF4 writer