compute_tidal_elevations.py

  • Calculates tidal elevations for an input file following [Egbert2002]

  • Can use OTIS format tidal solutions provided by Ohio State University and ESR

  • Can use Global Tide Model (GOT) solutions provided by Richard Ray at GSFC

  • Can use Finite Element Solution (FES) models provided by AVISO

  • Can read and write ascii, netCDF4, HDF5, parquet and geotiff formats

Source code

Calling Sequence

usage: compute_tidal_elevations.py [-h] [--directory DIRECTORY]
                                   [--tide {AODTM-5,AOTIM-5,AOTIM-5-2018,Arc2kmTM,CATS0201,CATS2008,CATS2008-v2023,CATS2008_load,EOT20,EOT20_load,FES2014,FES2014_load,GOT4.10,GOT4.10_load,GOT4.7,GOT4.7_load,GOT4.8,GOT4.8_load,Gr1km-v2,Gr1kmTM,HAMTIDE11,TPXO7.2,TPXO7.2_load,TPXO8-atlas,TPXO9-atlas,TPXO9-atlas-v2,TPXO9-atlas-v3,TPXO9-atlas-v4,TPXO9-atlas-v5,TPXO9.1}]
                                   [--atlas-format {OTIS,netcdf}] [--gzip]
                                   [--definition-file DEFINITION_FILE]
                                   [--format {csv,netCDF4,HDF5,geotiff,parquet}]
                                   [--variables VARIABLES [VARIABLES ...]]
                                   [--header HEADER] [--delimiter DELIMITER]
                                   [--type {drift,grid,time series}]
                                   [--epoch EPOCH]
                                   [--deltatime DELTATIME [DELTATIME ...]]
                                   [--standard {UTC,GPS,TAI,LORAN,datetime}]
                                   [--projection PROJECTION]
                                   [--interpolate METHOD] [--extrapolate]
                                   [--cutoff CUTOFF] [--infer-minor]
                                   [--apply-flexure] [--fill-value FILL_VALUE]
                                   [--verbose] [--mode MODE]
                                   [infile] [outfile]

Positional Arguments

infile

Input file to run

outfile

Computed output file

Named Arguments

--directory, -D

Working data directory

--tide, -T

Possible choices: AODTM-5, AOTIM-5, AOTIM-5-2018, Arc2kmTM, CATS0201, CATS2008, CATS2008-v2023, CATS2008_load, EOT20, EOT20_load, FES2014, FES2014_load, GOT4.10, GOT4.10_load, GOT4.7, GOT4.7_load, GOT4.8, GOT4.8_load, Gr1km-v2, Gr1kmTM, HAMTIDE11, TPXO7.2, TPXO7.2_load, TPXO8-atlas, TPXO9-atlas, TPXO9-atlas-v2, TPXO9-atlas-v3, TPXO9-atlas-v4, TPXO9-atlas-v5, TPXO9.1

Tide model to use in correction

--atlas-format

Possible choices: OTIS, netcdf

ATLAS tide model format

--gzip, -G

Tide model files are gzip compressed

--definition-file

Tide model definition file

--format, -F

Possible choices: csv, netCDF4, HDF5, geotiff, parquet

Input and output data format

--variables, -v

Variable names of data in input file

--header, -H

Number of header lines for csv files

--delimiter

Delimiter for csv or ascii files

--type, -t

Possible choices: drift, grid, time series

Input data type

  • 'drift': drift buoys or satellite/airborne altimetry (time per data point)

  • 'grid': spatial grids or images (single time for all data points)

  • 'time series': station locations with multiple time values

--epoch, -e

Reference epoch of input time

  • 'days since 1858-11-17T00:00:00' (default Modified Julian Days)

--deltatime, -d

Input delta time for files without date variables

  • can be set to 0 to use exact calendar date from epoch

--standard, -s

Possible choices: UTC, GPS, TAI, LORAN, datetime

Input time standard for delta times

  • 'UTC': Coordinate Universal Time

  • 'GPS': GPS Time

  • 'LORAN': Long Range Navigator Time

  • 'TAI': International Atomic Time

  • 'datetime': formatted datetime string in UTC

--projection, -P

Spatial projection as EPSG code or PROJ4 string

--interpolate, -I

Possible choices: spline, linear, nearest, bilinear

Spatial interpolation method

--extrapolate, -E

Extrapolate with nearest-neighbors

--cutoff, -c

Extrapolation cutoff in kilometers

  • set to 'inf' to extrapolate for all points

--infer-minor

Infer the height values for minor constituents

--apply-flexure

Apply ice flexure scaling factor to height values

Only valid for models containing flexure fields

--fill-value, -f

Invalid value for spatial fields

--verbose, -V

Verbose output of processing run

--mode, -M

Permission mode of output file

References

Egbert2002

G. D. Egbert and S. Y. Erofeeva, “Efficient Inverse Modeling of Barotropic Ocean Tides,” Journal of Atmospheric and Oceanic Technology, 19(2), 183–204, (2002). doi: 10.1175/1520-0426(2002)019<0183:EIMOBO>2.0.CO;2