calc_mascon.py

  • Reads in GRACE/GRACE-FO spherical harmonic coefficients

  • Correct spherical harmonics with the specified GIA model group

  • Filters and smooths data with specified processing algorithms [33, 64]

  • Calculates a time-series of regional mass anomalies through a least-squares mascon procedure following Jacob et al. [31], Tiwari et al. [67]

  • Calculates the regional mascon errors following Wahr et al. [75]

Source code

Calling Sequence

usage: calc_mascon.py [-h] [--directory DIRECTORY]
                      [--output-directory OUTPUT_DIRECTORY] --center PROC
                      [--release DREL] [--product DSET] [--lmin LMIN]
                      [--lmax LMAX] [--mmax MMAX] [--start START] [--end END]
                      [--missing MISSING [MISSING ...]] [--love {0,1,2,3,4}]
                      [--reference {CF,CM,CE}] [--radius RADIUS] [--destripe]
                      [--gia GIA] [--gia-file GIA_FILE] [--atm-correction]
                      [--pole-tide] [--geocenter DEG1]
                      [--geocenter-file GEOCENTER_FILE]
                      [--interpolate-geocenter] [--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}]
                      [--format {ascii,netCDF4,HDF5}] [--mean-file MEAN_FILE]
                      [--mean-format {ascii,netCDF4,HDF5,gfc}]
                      [--mascon-file MASCON_FILE]
                      [--mascon-format {ascii,netCDF4,HDF5}]
                      [--redistribute-mascons] [--fit-method {1,2}]
                      [--solver {inv,lstsq,gelsd,gelsy,gelss}]
                      [--remove-file REMOVE_FILE [REMOVE_FILE ...]]
                      [--remove-format {ascii,netCDF4,HDF5,index-ascii,index-netCDF4,index-HDF5} [{ascii,netCDF4,HDF5,index-ascii,index-netCDF4,index-HDF5} ...]]
                      [--redistribute-removed] [--remove-reconstruct]
                      [--reconstruct-file RECONSTRUCT_FILE] [--mask MASK]
                      [--log] [--verbose] [--mode MODE]

Named Arguments

--directory, -D

Working data directory

--output-directory, -O

Output directory for mascon files

--center, -c

GRACE/GRACE-FO Processing Center

--release, -r

GRACE/GRACE-FO Data Release

--product, -p

GRACE/GRACE-FO Level-2 data product

--lmin

Minimum spherical harmonic degree

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

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

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

--geocenter

Possible choices: Tellus, SLR, SLF, UCI, Swenson, GFZ

Update Degree 1 coefficients with SLR or derived values

  • None

  • 'Tellus': GRACE/GRACE-FO TN-13 coefficients from PO.DAAC

  • 'SLR': satellite laser ranging coefficients from CSR

  • 'UCI': Sutterley and Velicogna coefficients, Remote Sensing (2019)

  • 'Swenson': GRACE-derived coefficients from Sean Swenson

  • 'GFZ': GRACE/SLR derived coefficients from GFZ GravIS

--geocenter-file

Specific geocenter file if not default

--interpolate-geocenter

Least-squares model missing Degree 1 coefficients

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

--format, -F

Possible choices: ascii, netCDF4, HDF5

Input data format for auxiliary files

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

--mascon-file

Index file of mascons spherical harmonics

--mascon-format

Possible choices: ascii, netCDF4, HDF5

Input data format for mascon files

--redistribute-mascons

Redistribute mascon mass over the ocean

--fit-method

Possible choices: 1, 2

Method for fitting sensitivity kernel to harmonics

  • 1: mass coefficients

  • 2: geoid coefficients

--solver, -s

Least squares solver for sensitivity kernels

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

--remove-file

Monthly files to be removed from the GRACE/GRACE-FO data

--remove-format

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

Input data format for files to be removed

--redistribute-removed

Redistribute removed mass fields over the ocean

--remove-reconstruct

Remove reconstructed mascon time series fields

--reconstruct-file

Reconstructed mascon time series file to be removed

--mask

Land-sea mask for redistributing mascon mass and land water flux

--log

Output log file for each job

--verbose, -V

Verbose output of processing run

--mode, -M

Permissions mode of output files