reduce_otis

  • Reduces OTIS-format tidal files to a regional subset

Source code

pyTMD.datasets.reduce_otis(model: str, directory: str | Path | None = PosixPath('/home/docs/.cache/pytmd'), bounds: list = [None, None, None, None], crs: str | int = '4326', mode: oct = 509, **kwargs)[source]

Reads OTIS-format tidal files and reduces to a regional subset

Parameters:
model: str

Tide model to use

directory: str or pathlib.Path

Working data directory

bounds: list, default 4*[None]

Grid bounds for reducing model [xmin,xmax,ymin,ymax]

crs: str or int, default ‘4326’

Spatial projection as EPSG code or PROJ4 string

mode: oct, default 0o775

Permission mode of the output files

CLI

usage: reduce_otis.py [-h] [--directory DIRECTORY] [--tide TIDE]
                      [--projection PROJECTION] [--bounds xmin xmax ymin ymax]
                      [--verbose] [--mode MODE]

Named Arguments

--directory, -D

Working data directory

--tide, -T

Possible choices: CATS0201, CATS2008, CATS2008_load, TPXO9-atlas, TPXO9.1, TPXO8-atlas, TPXO7.2, TPXO7.2_load, AODTM-5, AOTIM-5, AOTIM-5-2018

Tide model to use

--projection, -P

Spatial projection as EPSG code or PROJ4 string

--bounds, -B

Grid bounds for reducing model

--verbose, -V

Verbose output of processing run

--mode, -M

Permission mode of the output files