calc_degree_one.py

  • Calculates degree 1 variations using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations [60, 62].

Source code

Calling Sequence

usage: calc_degree_one.py [-h] [--directory DIRECTORY] --center PROC
                          [--release DREL] [--lmax LMAX] [--mmax MMAX]
                          [--start START] [--end END]
                          [--missing MISSING [MISSING ...]]
                          [--love {0,1,2,3,4}] [--kl [KL]] [--radius RADIUS]
                          [--destripe] [--gia GIA] [--gia-file GIA_FILE]
                          [--atm-correction] [--pole-tide]
                          [--slr-c20 {CSR,GFZ,GSFC}] [--slr-21 {CSR,GFZ,GSFC}]
                          [--slr-22 {CSR,GSFC}]
                          [--slr-c30 {CSR,GFZ,GSFC,LARES}]
                          [--slr-c40 {CSR,GSFC,LARES}]
                          [--slr-c50 {CSR,GSFC,LARES}] [--ocean-model MODEL]
                          [--format {ascii,netCDF4,HDF5}]
                          [--ocean-file OCEAN_FILE] [--mean-file MEAN_FILE]
                          [--mean-format {ascii,netCDF4,HDF5,gfc}]
                          [--iterative]
                          [--solver {inv,lstsq,gelsd,gelsy,gelss}]
                          [--fingerprint] [--expansion EXPANSION]
                          [--mask MASK] [--plot] [--copy] [--log] [--verbose]
                          [--mode MODE]

Named Arguments

--directory, -D

Working data directory

--center, -c

GRACE/GRACE-FO Processing Center

--release, -r

GRACE/GRACE-FO Data Release

--lmax, -l

Maximum spherical harmonic degree

--mmax, -m

Maximum spherical harmonic order

--start, -S

Starting GRACE/GRACE-FO month

--end, -E

Ending GRACE/GRACE-FO month

--missing, -N

Missing GRACE/GRACE-FO months

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

--kl, -k

Degree 1 gravitational Load Love number

  • None: use derived values from [5, 69].

--radius, -R

Gaussian smoothing radius (km)

--destripe, -d

Use decorrelation (destriping) filter

--gia, -G

Possible choices: IJ05-R2, W12a, SM09, ICE6G, Wu10, AW13-ICE6G, AW13-IJ05, Caron, ICE6G-D, ascii, netCDF4, HDF5

GIA model type to read

  • 'IJ05-R2': Ivins R2 GIA Models [29]

  • 'W12a': Whitehouse GIA Models [82]

  • 'SM09': Simpson/Milne GIA Models [57]

  • 'ICE6G': ICE-6G GIA Models [48]

  • 'Wu10': Wu (2010) GIA Correction [83]

  • 'AW13-ICE6G': Geruo A ICE-6G GIA Models [1]

  • 'AW13-IJ05': Geruo A IJ05-R2 GIA Models [1]

  • 'Caron': Caron JPL GIA Assimilation [7]

  • 'ICE6G-D': ICE-6G Version-D GIA Models [49]

  • 'ascii': reformatted GIA in ascii format

  • 'netCDF4': reformatted GIA in netCDF4 format

  • 'HDF5': reformatted GIA in HDF5 format

--gia-file

GIA file to read

--atm-correction

Apply atmospheric jump correction coefficients

--pole-tide

Correct for pole tide drift

--slr-c20

Replace C20 coefficients with SLR values

  • None: use original values

  • 'CSR': use values from CSR (TN-07, TN-09, TN-11)

  • 'GFZ': use values from GFZ

  • 'GSFC': use values from GSFC (TN-14)

--slr-21

Possible choices: CSR, GFZ, GSFC

Replace C21 and S21 coefficients with SLR values

--slr-22

Replace C22 and S22 coefficients with SLR values

  • None: use original values

  • 'CSR': use values from CSR

  • 'GSFC': use values from GSFC

--slr-c30

Replace C30 coefficients with SLR values

  • None: use original values

  • 'CSR': use values from CSR (5×5 with 6,1)

  • 'GFZ': use values from GFZ GravIS

  • 'GSFC': use values from GSFC (TN-14)

  • 'LARES': use filtered values from CSR

--slr-c40

Replace C40 coefficients with SLR values

  • None: use original values

  • 'CSR': use values from CSR (5×5 with 6,1)

  • 'GSFC': use values from GSFC

  • 'LARES': use filtered values from CSR

--slr-c50

Replace C50 coefficients with SLR values

  • None: use original values

  • 'CSR': use values from CSR (5×5 with 6,1)

  • 'GSFC': use values from GSFC

  • 'LARES': use filtered values from CSR

--ocean-model

Possible choices: OMCT, MPIOM, ECCO_kf080i, ECCO_dr080i, ECCO_V4r3, ECCO_V4r4, ECCO_V5alpha

Ocean model to use

--format, -F

Possible choices: ascii, netCDF4, HDF5

Input data format for ocean models

--ocean-file

Index file for ocean model harmonics

--mean-file

GRACE/GRACE-FO mean file to remove from the harmonic data

--mean-format

Possible choices: ascii, netCDF4, HDF5, gfc

Input data format for GRACE/GRACE-FO mean file

--iterative

Iterate degree one solutions

--solver, -s

Least squares solver for degree one solutions

  • 'inv': matrix inversion

  • 'lstsq': least squares solution

  • 'gelsy': complete orthogonal factorization solution

  • 'gelss': singular value decomposition (SVD) solution

  • 'gelsd': singular value decomposition (SVD) solution with a divide and conquer method

--fingerprint

Redistribute land-water flux using sea level fingerprints

--expansion, -e

Spherical harmonic expansion for sea level fingerprints

--mask

Land-sea mask for calculating ocean mass and land water flux

--plot, -p

Create output plots for components and iterations

--copy, -C

Copy output files for distribution and archival

--log

Output log file for each job

--verbose, -V

Verbose output of processing run

--mode, -M

Permissions mode of output files