compute_tides_ICESat2_ATL10.py

  • Calculates tidal elevations for correcting ICESat-2 sea ice freeboard data

  • Can use OTIS format tidal solutions provided by Oregon 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

Source code

usage: compute_tides_ICESat2_ATL10.py [-h] [--directory DIRECTORY]
                                      [--output-directory OUTPUT_DIRECTORY]
                                      [--tide TIDE] [--gzip]
                                      [--definition-file DEFINITION_FILE]
                                      [--crop] [--interpolate METHOD]
                                      [--extrapolate] [--cutoff CUTOFF]
                                      [--nodal-corrections CORRECTIONS]
                                      [--infer-minor]
                                      [--minor-constituents MINOR [MINOR ...]]
                                      [--append-node] [--verbose]
                                      [--mode MODE]
                                      infile [infile ...]

Positional Arguments

infile

ICESat-2 ATL10 file to run

Named Arguments

--directory, -D

Working data directory

--output-directory, -O

Output data directory

--tide, -T

Possible choices: AODTM-5, AOTIM-5, AOTIM-5-2018, Arc2kmTM, CATS0201, CATS2008, CATS2008-v2023, CATS2008_load, DTU23, EOT20, EOT20_load, FES2012, FES2014, FES2014_extrapolated, FES2014_load, FES2022, FES2022_extrapolated, FES2022_load, GOT4.10, GOT4.10_load, GOT4.7, GOT4.7_load, GOT4.8, GOT4.8_load, GOT5.5, GOT5.5D, GOT5.5D_extrapolated, GOT5.5_extrapolated, GOT5.5_load, GOT5.6, GOT5.6_extrapolated, Gr1km-v2, Gr1kmTM, HAMTIDE11, RE14, TPXO10-atlas-v2, TPXO10-atlas-v2-nc, TPXO7.2, TPXO7.2_load, TPXO8-atlas, TPXO8-atlas-nc, TPXO9-atlas, TPXO9-atlas-nc, TPXO9-atlas-v2, TPXO9-atlas-v2-nc, TPXO9-atlas-v3, TPXO9-atlas-v3-nc, TPXO9-atlas-v4, TPXO9-atlas-v4-nc, TPXO9-atlas-v5, TPXO9-atlas-v5-nc, TPXO9.1

Tide model to use in correction

--gzip, -G

Tide model files are gzip compressed

--definition-file

Tide model definition file

--crop

Crop tide model to bounds of data

--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

--nodal-corrections

Possible choices: OTIS, FES, GOT, perth3

Nodal corrections to apply

--infer-minor

Infer values for minor constituents

--minor-constituents

Minor constituents to infer

--append-node

Append equilibrium amplitudes for node tides

--verbose, -V

Output information about each created file

--mode, -M

Permission mode of directories and files created