run_sea_level_equation.py

  • Solves the sea level equation with the option of including polar motion feedback [20, 35, 45]

  • Uses a Clenshaw summation to calculate the spherical harmonic summation [26, 70]

Source code

Calling Sequence

usage: run_sea_level_equation.py [-h] [--mask MASK] [--lmax LMAX]
                                 [--love {0,1,2,3,4}] [--body {0,1}]
                                 [--density DENSITY] [--fluid {0,1,2,3}]
                                 [--iterations ITERATIONS] [--polar-feedback]
                                 [--reference {CF,CM,CE}]
                                 [--format {ascii,netCDF4,HDF5,index-ascii,index-netCDF4,index-HDF5}]
                                 [--input-type {harmonics,spatial}] [--date]
                                 [--units {1,2,3}] [--verbose] [--mode MODE]
                                 [infile] [outfile]

Positional Arguments

infile

Input load file

outfile

Output sea level fingerprints file

Named Arguments

--mask

Land-sea mask for calculating sea level fingerprints

--lmax, -l

Maximum spherical harmonic degree

--love, -n

Possible choices: 0, 1, 2, 3, 4

Treatment of the Load Love numbers

  • 0: Han and Wahr (1995) values from PREM [23]

  • 1: Gegout (2005) values from PREM [21]

  • 2: Wang et al. (2012) values from PREM [80]

  • 3: Wang et al. (2012) values from PREM with hard sediment [80]

  • 4: Wang et al. (2012) values from PREM with soft sediment [80]

--body, -b

Possible choices: 0, 1

Treatment of the body tide Love number

  • 0: [77] and [78] values from PREM

  • 1: [19] values from Gutenberg-Bullen oceanic mantle model

--density, -d

Density of water in g/cm^3

--fluid, -f

Possible choices: 0, 1, 2, 3

Treatment of the fluid Love number

  • 0: [22] fluid love number

  • 1: [47] secular love number

  • 2: [47] fluid love number

  • 3: [37] fluid love number

--iterations, -I

Maximum number of iterations

--polar-feedback

Include polar feedback [78]

--reference

Possible choices: CF, CM, CE

Reference frame for load Love numbers

  • 'CF': Center of Surface Figure

  • 'CM': Center of Mass of Earth System

  • 'CE': Center of Mass of Solid Earth

--format, -F

Possible choices: ascii, netCDF4, HDF5, index-ascii, index-netCDF4, index-HDF5

Input and output data format

--input-type, -T

Possible choices: harmonics, spatial

Input data type for load fields

--date, -D

Input and output files have date information

--units, -U

Possible choices: 1, 2, 3

Input units of spatial fields

--verbose, -V

Verbose output of run

--mode, -M

Permissions mode of output files