ATLAS

• Reads ATLAS-netcdf tidal solutions provided by Oregon State University

Calling Sequence

import pyTMD.io
ds = pyTMD.io.ATLAS.open_dataset(model_files, grid_file, group='z')

Source code

pyTMD.io.ATLAS.open_dataset(model_files: list[str] | list[Path], grid_file: str | Path, **kwargs)

Open ATLAS tide model file

Parameters:

model_files: list of str or pathlib.Path

List of ATLAS model files

grid_file: str or pathlib.path

ATLAS model grid file

kwargs: dict

Additional keyword arguments for opening ATLAS files

Returns:

ds: xarray.Dataset

ATLAS tide model data

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

Open multiple ATLAS model files

Parameters:

model_files: list of str or pathlib.Path

List of ATLAS model files

parallel: bool, default False

Open files in parallel using dask.delayed

kwargs: dict

Additional keyword arguments for opening ATLAS files

Returns:

ds: xarray.Dataset

ATLAS tide model data

pyTMD.io.ATLAS.open_atlas_grid(input_file: str | Path, group: str = 'z', **kwargs)

Open ATLAS model grid file

Parameters:

input_file: str or pathlib.Path

ATLAS model grid file

group: str, default ‘z’

Tidal variable to read

• 'z': heights

• 'u': zonal currents

• 'U': zonal depth-averaged transport

• 'v': meridional currents

• 'V': meridional depth-averaged transport

compressed: bool, default False

Input file is gzip compressed

Returns:

ds: xarray.Dataset

ATLAS tide model data

pyTMD.io.ATLAS.open_atlas_dataset(input_file: str | Path, group: str = 'z', chunks: int | dict | str | None = None, **kwargs)

Open ATLAS-formatted netCDF4 files

Parameters:

input_file: str or pathlib.Path

Input ATLAS file

group: str, default ‘z’

Tidal variable to read

• 'z': heights

• 'u': zonal currents

• 'U': zonal depth-averaged transport

• 'v': meridional currents

• 'V': meridional depth-averaged transport

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

ATLAS tide model data

class pyTMD.io.ATLAS.ATLASDataset(ds)

xarray.Dataset utilities for ATLAS-netcdf tidal models

to_grid(path: str | Path, mode: str = 'w', encoding: dict = {'complevel': 9, 'zlib': True}, astype: str = 'float32', **kwargs)

Writes grid data to netCDF4 files in ATLAS format

Parameters:

path: str or pathlib.Path

Output ATLAS-netcdf grid file name

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

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

Writes tidal constituents to netCDF4 files in ATLAS format

Parameters:

path: str or pathlib.Path

Output directory for ATLAS-netcdf 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

class pyTMD.io.ATLAS.ATLASDataTree(dtree)

xarray.DataTree utilities for ATLAS-netcdf tidal models

to_netcdf(grid_file: str | Path, directory: str | Path | None = None, **kwargs)

Writes netCDF4 files in ATLAS format

Parameters:

grid_file: str or pathlib.Path

Output ATLAS-netcdf grid file

directory: str or pathlib.Path

Output directory for ATLAS-netcdf files

kwargs: dict

Additional keyword arguments for netCDF4 writer