grace_spatial_error.py

  • Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports spatial error field following Wahr et al. [75]

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

  • Converts data to specified units and performs a spherical harmonic summation to convert error field to the spatial domain [73]

Source code

Calling Sequence

usage: grace_spatial_error.py [-h] [--directory DIRECTORY]
                              [--output-directory OUTPUT_DIRECTORY]
                              [--file-prefix FILE_PREFIX] --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]
                              [--units {1,2,3,4,5}]
                              [--spacing dlon [dlat ...]] [--interval {1,2,3}]
                              [--bounds lon_min lon_max lat_min lat_max]
                              [--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}] [--log]
                              [--verbose] [--mode MODE]

Named Arguments

--directory, -D

Working data directory

--output-directory, -O

Output directory for spatial files

--file-prefix, -P

Prefix string for input and output 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

--units, -U

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

Output units

  • 1: cm of water thickness

  • 2: mm of geoid height

  • 3: mm of elastic crustal deformation

  • 4: μGal gravitational perturbation

  • 5: mbar equivalent surface pressure

--spacing

Spatial resolution of output data

--interval

Output grid interval

  • 1: (0:360, 90:-90)

  • 2: (degree spacing/2)

  • 3: non-global grid (set with defined bounds)

--bounds

Bounding box for non-global grid

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

Possible choices: CSR, GSFC, LARES

Replace C40 coefficients with SLR values

--slr-c50

Replace C50 coefficients with SLR values

  • None: use original values

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

  • 'GSFC': use values from GSFC

  • 'LARES': use filtered values from CSR

--format, -F

Possible choices: ascii, netCDF4, HDF5

Input/output data format

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

--log

Output log file for each job

--verbose, -V

Verbose output of run

--mode, -M

Permissions mode of output files