Getting Started
This documentation is intended to explain how to compute spatial and time series
estimates using GRACE/GRACE-FO time-variable gravity measurements.
gravity-toolkit is a Python-based geophysical software that reads
GRACE/GRACE-FO time-variable gravity solutions for estimating regional mass change.
A suite of geophysical corrections can be applied to the gravity solutions to
optimize the GRACE/GRACE-FO data for particular applications.
This software was developed with the goal of supporting science applications for
time-variable gravity.
gravity-toolkit provides data access utilities for ascii, netCDF4, HDF5 and gfc file formats.
gravity-toolkit also provides some very high-level plotting programs through the
use of Jupyter Notebooks.
![digraph {
G [label="GRACE/GRACE-FO\ntime-variable gravity"
fontname="Lato"
fontsize=11
shape=box
style="filled"
color="#7570b3"]
A [label="Non-tidal Ocean and\nAtmospheric Variation"
fontname="Lato"
fontsize=11
shape=box
style="filled"
color="#7570b3"]
I [label="Glacial Isostatic\nAdjustment"
fontname="Lato"
fontsize=11
shape=box
style="filled"
color="#7570b3"]
W [label="Terrestrial Water\nStorage"
fontname="Lato"
fontsize=11
shape=box
style="filled"
color="#7570b3"]
R [label="gravity-toolkit"
fontname="Lato"
fontsize=11
shape=box
style="filled"
color="gray"]
S [label="Spatial Maps"
fontname="Lato"
fontsize=11
shape=box
style="filled"
color="#1b9e77"
URL="Spatial-Maps.html"]
T [label="Time Series Analysis"
fontname="Lato"
fontsize=11
shape=box
style="filled"
color="#1b9e77"
URL="Time-Series-Analysis.html"]
D [label="Geocenter Variation"
fontname="Lato"
fontsize=11
shape=box
style="filled"
color="#1b9e77"
URL="Geocenter-Variations.html"]
G -> R [arrowsize=0.8]
A -> R [arrowsize=0.8]
I -> R [arrowsize=0.8]
W -> R [arrowsize=0.8]
R -> S [arrowsize=0.8]
R -> T [arrowsize=0.8]
R -> D [arrowsize=0.8]
}](../_images/graphviz-310c88071ece92f977683a81f6dc4cae5519c3c7.png)
Fig. 1 Data Processing Framework
Steps to Get Started
Run podaac_cumulus.py program with your NASA Earthdata credentials to acquire GRACE/GRACE-FO and auxiliary data
python podaac_cumulus.py --user=<username> --directory=<path_to_grace_directory> --release RL06
Run cnes_grace_sync.py program to acquire CNES/GRGS GRACE/GRACE-FO data
python cnes_grace_sync.py --directory=<path_to_grace_directory> --release RL05
Get geocenter results from Sutterley and Velicogna (2019) if wanting to use that dataset
import gravity_toolkit.utilities
gravity_toolkit.utilities.from_figshare(path_to_grace_directory,verbose=True)
If correcting for Glacial Isostatic Adjustment: have full path to data file known
These can be ascii files direct from many modeling groups or a reformatted ascii/netCDF4/HDF5 file
If correcting for other geophysical processes such as terrestrial water storage: have full path known
These can be a single netCDF4 or HDF5 file or an index of ascii/netCDF4/HDF5 files
Run Jupyter notebook Examples
These programs use Jupyter widgets to select datasets and processing parameters
Can also sync the data from within the Jupyter Notebook using magics