From 1de93a836e9368737ba02170a96fb3d02b41f2f1 Mon Sep 17 00:00:00 2001 From: Tyler Sutterley Date: Thu, 19 Dec 2024 19:43:58 -0500 Subject: [PATCH] docs: use `sphinxcontrib-bibtex` for citations (#154) --- doc/environment.yml | 3 +- doc/source/_assets/gravity-refs.bib | 1058 +++++++++++++++++ doc/source/api_reference/calc_degree_one.rst | 49 +- .../calc_harmonic_resolution.rst | 9 +- doc/source/api_reference/calc_mascon.rst | 53 +- .../api_reference/calc_sensitivity_kernel.rst | 25 +- .../api_reference/combine_harmonics.rst | 25 +- .../api_reference/convert_harmonics.rst | 23 +- .../dealiasing_global_uplift.rst | 28 +- .../api_reference/destripe_harmonics.rst | 2 +- .../api_reference/grace_raster_grids.rst | 49 +- .../api_reference/grace_spatial_error.rst | 33 +- .../api_reference/grace_spatial_maps.rst | 47 +- .../api_reference/mascon_reconstruct.rst | 28 +- .../api_reference/monte_carlo_degree_one.rst | 53 +- doc/source/api_reference/ocean_stokes.rst | 4 +- .../api_reference/run_sea_level_equation.rst | 61 +- doc/source/api_reference/scale_grace_maps.rst | 55 +- doc/source/api_reference/tools.rst | 17 - doc/source/api_reference/units.rst | 14 - doc/source/conf.py | 15 +- doc/source/getting_started/Background.rst | 31 +- doc/source/getting_started/Bibliography.rst | 5 + .../getting_started/Geocenter-Variations.rst | 37 +- doc/source/getting_started/Spatial-Maps.rst | 81 +- .../getting_started/Time-Series-Analysis.rst | 31 +- doc/source/index.rst | 7 + gravity_toolkit/associated_legendre.py | 50 +- gravity_toolkit/clenshaw_summation.py | 29 +- gravity_toolkit/destripe_harmonics.py | 8 +- gravity_toolkit/gauss_weights.py | 8 +- gravity_toolkit/gen_averaging_kernel.py | 16 +- gravity_toolkit/gen_disc_load.py | 24 +- gravity_toolkit/gen_point_load.py | 15 +- gravity_toolkit/gen_spherical_cap.py | 24 +- gravity_toolkit/gen_stokes.py | 11 +- gravity_toolkit/geocenter.py | 69 +- gravity_toolkit/grace_input_months.py | 67 +- gravity_toolkit/harmonic_gradients.py | 16 +- gravity_toolkit/harmonic_summation.py | 34 +- gravity_toolkit/harmonics.py | 9 +- gravity_toolkit/legendre.py | 10 +- gravity_toolkit/legendre_polynomials.py | 9 +- gravity_toolkit/mascons.py | 38 +- gravity_toolkit/read_GIA_model.py | 64 +- gravity_toolkit/read_GRACE_harmonics.py | 10 +- gravity_toolkit/read_SLR_harmonics.py | 18 +- gravity_toolkit/read_gfc_harmonics.py | 10 +- gravity_toolkit/read_love_numbers.py | 83 +- gravity_toolkit/sea_level_equation.py | 57 +- gravity_toolkit/spatial.py | 13 +- gravity_toolkit/time.py | 18 +- gravity_toolkit/time_series/lomb_scargle.py | 20 +- gravity_toolkit/time_series/piecewise.py | 15 +- gravity_toolkit/time_series/regress.py | 9 +- gravity_toolkit/time_series/savitzky_golay.py | 11 +- gravity_toolkit/time_series/smooth.py | 9 +- gravity_toolkit/tools.py | 12 +- gravity_toolkit/units.py | 8 +- gravity_toolkit/utilities.py | 9 +- scripts/calc_mascon.py | 3 +- scripts/calc_sensitivity_kernel.py | 3 +- scripts/dealiasing_global_uplift.py | 3 +- scripts/grace_raster_grids.py | 3 +- scripts/grace_spatial_error.py | 3 +- scripts/grace_spatial_maps.py | 3 +- scripts/mascon_reconstruct.py | 3 +- scripts/piecewise_grace_maps.py | 3 +- scripts/regress_grace_maps.py | 3 +- scripts/scale_grace_maps.py | 3 +- 70 files changed, 1412 insertions(+), 1264 deletions(-) create mode 100644 doc/source/_assets/gravity-refs.bib create mode 100644 doc/source/getting_started/Bibliography.rst diff --git a/doc/environment.yml b/doc/environment.yml index 5e6432d6..d447bc36 100644 --- a/doc/environment.yml +++ b/doc/environment.yml @@ -17,7 +17,8 @@ dependencies: - pyyaml - scipy - sphinx + - sphinx-argparse>=0.4 + - sphinxcontrib-bibtex - sphinx_rtd_theme - pip: - - sphinx-argparse>=0.4 - .. diff --git a/doc/source/_assets/gravity-refs.bib b/doc/source/_assets/gravity-refs.bib new file mode 100644 index 00000000..60d5a53d --- /dev/null +++ b/doc/source/_assets/gravity-refs.bib @@ -0,0 +1,1058 @@ +@article{A:2013kh, +author = {A, G and Wahr, J and Zhong, S}, +title = {{Computations of the viscoelastic response of a 3-D compressible Earth to surface loading: an application to Glacial Isostatic Adjustment in Antarctica and Canada}}, +journal = {Geophysical Journal International}, +year = {2013}, +month = feb, +volume = {192}, +number = {2}, +issn = {0956-540X}, +url = {https://doi.org/10.1093/gji/ggs030}, +doi = {10.1093/gji/ggs030}, +pages = {557--572}, +publisher = {Oxford University Press (OUP)}, +} +@book{Abramowitz:1965vw, +author = {Abramowitz, M and Stegun, I A}, +title = {{Handbook of Mathematical Functions}}, +year = {1965}, +isbn = {9780486612720}, +publisher = {Dover Publications}, +address = {New York}, +} +@article{Bandikova:2019ji, +author = {Bandikova, T and McCullough, C and Kruizinga, G L and Save, H and Christophe, B}, +title = {{GRACE accelerometer data transplant}}, +journal = {Advances in Space Research}, +year = {2019}, +month = aug, +volume = {64}, +number = {3}, +issn = {0273-1177}, +url = {https://doi.org/10.1016/j.asr.2019.05.021}, +doi = {10.1016/j.asr.2019.05.021}, +pages = {623--644}, +publisher = {Elsevier BV}, +} +@techreport{Barthelmes:2013fy, +author = {Barthelmes, F}, +title = {{Definition of Functionals of the Geopotential and Their Calculation from Spherical Harmonic Models}}, +year = {2013}, +number = {STR09/02}, +url = {https://doi.org/10.2312/GFZ.b103-0902-26}, +doi = {10.2312/GFZ.b103-0902-26}, +institution = {GeoForschungsZentrum Scientific Technical Report}, +} +@article{Blewitt:2003bz, +author = {Blewitt, G}, +title = {{Self-consistency in reference frames, geocenter definition, and surface loading of the solid Earth}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2003}, +month = feb, +volume = {108}, +number = {B2}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/2002jb002082}, +doi = {10.1029/2002JB002082}, +publisher = {American Geophysical Union (AGU)}, +} +@book{Burnham:2002ms, +author = {Burnham, K P and Anderson, D R}, +title = {{Model Selection and Multimodel Inference}}, +publisher = {Springer-Verlag New York}, +year = {2002}, +edition = {2}, +ibsn = {0-387-95364-7}, +address = {175 Fifth Avenue, New York, NY} +} +@article{Caron:2018ba, +author = {Caron, L and Ivins, E R and Larour, E and Adhikari, S and Nilsson, J and Blewitt, G}, +title = {{GIA Model Statistics for GRACE Hydrology, Cryosphere, and Ocean Science}}, +journal = {Geophysical Research Letters}, +year = {2018}, +month = mar, +volume = {45}, +number = {5}, +issn = {0094-8276}, +url = {https://doi.org/10.1002/2017gl076644}, +doi = {10.1002/2017GL076644}, +pages = {2203--2212}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Chao:1987fq, +author = {Chao, B F and Gross, R S}, +title = {{Changes in the Earth's rotation and low-degree gravitational field induced by earthquakes}}, +journal = {Geophysical Journal International}, +year = {1987}, +month = dec, +volume = {91}, +number = {3}, +issn = {0956-540X}, +url = {https://doi.org/10.1111/j.1365-246x.1987.tb01659.x}, +doi = {10.1111/j.1365-246X.1987.tb01659.x}, +pages = {569--596}, +publisher = {Oxford University Press (OUP)}, +} +@article{Cheng:2011hh, +author = {Cheng, M and Ries, J C and Tapley, B D}, +title = {{Variations of the Earth's figure axis from satellite laser ranging and GRACE}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2011}, +month = jan, +volume = {116}, +number = {B1}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/2010JB000850}, +doi = {10.1029/2010JB000850}, +publisher = {John Wiley \& Sons, Ltd}, +keywords = {figure axis variations, pole tides, mean pole, core-mantle, SLR, GRACE}, +} +@inproceedings{Cheng:2013tz, +author = {Cheng, M K}, +title = {{Geocenter Variations from Analysis of SLR Data}}, +year = {2013}, +isbn = {978-3-642-32998-2}, +pages = {19--25}, +booktitle = {Reference Frames for Applications in Geosciences}, +publisher = {Springer Berlin Heidelberg}, +address = {Berlin, Heidelberg}, +editor = {Altamimi, Zuheir}, +} +@article{Cheng:2018jz, +author = {Cheng, M and Ries, J C}, +title = {{Decadal variation in Earth's oblateness (J2) from satellite laser ranging data}}, +journal = {Geophysical Journal International}, +year = {2018}, +month = feb, +volume = {212}, +number = {2}, +issn = {0956-540X}, +url = {https://doi.org/10.1093/gji/ggx483}, +doi = {10.1093/gji/ggx483}, +pages = {1218--1224}, +publisher = {Oxford University Press (OUP)}, +} +@techreport{Colombo:1981vh, +author = {Colombo, O L}, +title = {{Numerical Methods for Harmonic Analysis on the Sphere}}, +year = {1981}, +number = {OSURF Proj. No. 711664}, +institution = {United States Air Force}, +key = {Contract No. F19628-79-C-0027}, +pages = {140}, +} +@article{Dahle:2019jf, +author = {Dahle, C and Murb{\"o}ck, M and Flechtner, F and Dobslaw, H and Michalak, G and Neumayer, K and Abrykosov, O and Reinhold, A and K{\"o}nig, R and Sulzbach, R and F{\"o}rste, C}, +title = {{The GFZ GRACE RL06 Monthly Gravity Field Time Series: Processing Details and Quality Assessment}}, +journal = {Remote Sensing}, +year = {2019}, +month = sep, +volume = {11}, +number = {18}, +issn = {2072-4292}, +url = {https://doi.org/10.3390/rs11182116}, +doi = {10.3390/rs11182116}, +pages = {2116}, +publisher = {MDPI AG}, +} +@misc{Dahle:2019cu, +author = {Dahle, C and Murb{\"o}ck, M}, +title = {{Post-processed GRACE/GRACE-FO Geopotential GSM Coefficients GFZ RL06 (Level-2B Product)}}, +year = {2019}, +version = {0002}, +url = {http://doi.org/10.5880/GFZ.GRAVIS_06_L2B}, +doi = {10.5880/GFZ.GRAVIS_06_L2B}, +publisher = {GFZ Data Services}, +} +@article{Davis:2004il, +author = {Davis, J L and El{\'o}segui, P and Mitrovica, J X and Tamisiea, M E}, +title = {{Climate-driven deformation of the solid Earth from GRACE and GPS}}, +journal = {Geophysical Research Letters}, +year = {2004}, +month = dec, +volume = {31}, +number = {24}, +issn = {0094-8276}, +url = {https://doi.org/10.1029/2004gl021435}, +doi = {10.1029/2004GL021435}, +publisher = {American Geophysical Union (AGU)}, +} +@book{Dershowitz:2007cc, +author = {Dershowitz, N and Reingold, E M}, +title = {{Calendrical Calculations}}, +year = {2007}, +url = {https://doi.org/10.1017/CBO9781107051119}, +doi = {10.1017/CBO9781107051119}, +publisher = {Cambridge University Press}, +edition = {3}, +} +@article{Dziewonski:1981bz, +author = {Dziewonski, A M and Anderson, D L}, +title = {{Preliminary reference Earth model}}, +journal = {Physics of the Earth and Planetary Interiors}, +year = {1981}, +month = jun, +volume = {25}, +number = {4}, +issn = {0031-9201}, +url = {https://doi.org/10.1016/0031-9201(81)90046-7}, +doi = {10.1016/0031-9201(81)90046-7}, +pages = {297--356}, +publisher = {Elsevier BV}, +} +@article{Fagiolini:2015kc, +author = {Fagiolini, E and Flechtner, F and Horwath, M and Dobslaw, H}, +title = {{Correction of inconsistencies in ECMWF's operational analysis data during de-aliasing of GRACE gravity models}}, +journal = {Geophysical Journal International}, +year = {2015}, +month = sep, +volume = {202}, +number = {3}, +issn = {0956-540X}, +url = {https://doi.org/10.1093/gji/ggv276}, +doi = {10.1093/gji/ggv276}, +pages = {2150--2158}, +publisher = {Oxford University Press (OUP)}, +} +@article{Farrell:1972cm, +author = {Farrell, W E}, +title = {{Deformation of the Earth by surface loads}}, +journal = {Reviews of Geophysics}, +year = {1972}, +month = aug, +volume = {10}, +number = {3}, +issn = {8755-1209}, +url = {https://doi.org/10.1029/rg010i003p00761}, +doi = {10.1029/RG010i003p00761}, +pages = {761--797}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Farrell:1976hm, +author = {Farrell, W E and Clark, J A}, +title = {{On Postglacial Sea Level}}, +journal = {Geophysical Journal of the Royal Astronomical Society}, +year = {1976}, +month = sep, +volume = {46}, +number = {3}, +issn = {1365-246X}, +url = {https://doi.org/10.1111/j.1365-246X.1976.tb01252.x}, +doi = {10.1111/j.1365-246X.1976.tb01252.x}, +pages = {647--667}, +publisher = {Blackwell Publishing Ltd}, +} +@misc{Gegout:2010gc, +author = {Gegout, P and Boehm, J and Wijaya, D}, +title = {{Practical numerical computation of love numbers and applications}}, +journal = {Workshop of the COST Action ES0701}, +year = {2010}, +url = {https://doi.org/10.13140/RG.2.1.1866.7045}, +doi = {10.13140/RG.2.1.1866.7045}, +} +@inbook{Han:1989kj, +author = {Han, D and Wahr, J}, +title = {{Post-Glacial Rebound Analysis for a Rotating Earth}}, +year = {1989}, +volume = {49}, +isbn = {9781118666302}, +url = {https://doi.org/10.1029/GM049p0001}, +doi = {10.1029/GM049p0001}, +pages = {1--6}, +booktitle = {Slow Deformation and Transmission of Stress in the Earth}, +publisher = {American Geophysical Union}, +series = {Geophysical Monograph Series}, +keywords = {Rock deformation, Plate tectonics}, +} +@article{Han:1995go, +author = {Han, D and Wahr, J}, +title = {{The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound}}, +journal = {Geophysical Journal International}, +year = {1995}, +month = feb, +volume = {120}, +number = {2}, +issn = {0956-540X}, +url = {https://doi.org/10.1111/j.1365-246x.1995.tb01819.x}, +doi = {10.1111/j.1365-246X.1995.tb01819.x}, +pages = {287--311}, +publisher = {Oxford University Press (OUP)}, +} +@article{Hatcher:1984uo, +author = {Hatcher, D A}, +title = {{Simple Formulae for Julian Day Numbers and Calendar Dates}}, +journal = {Quarterly Journal of the Royal Astronomical Society}, +year = 1984, +month = mar, +url = {https://ui.adsabs.harvard.edu/abs/1984QJRAS..25...53H}, +key = {1984QJRAS..25...53H}, +volume = {25}, +pages = {53--55}, +publisher = {Royal Astronomical Society}, +note = {Provided by the SAO/NASA Astrophysics Data System} +} +@book{HofmannWellenhof:2006hy, +author = {Hofmann-Wellenhof, B and Moritz, H}, +title = {{Physical Geodesy}}, +year = {2006}, +isbn = {9783211335444}, +url = {https://doi.org/10.1007/978-3-211-33545-1}, +doi = {10.1007/978-3-211-33545-1}, +publisher = {Springer Vienna}, +} +@article{Holmes:2002ff, +author = {Holmes, S A and Featherstone, W E}, +title = {{A unified approach to the Clenshaw summation and the recursive computation of very high degree and order normalised associated Legendre functions}}, +journal = {Journal of Geodesy}, +year = {2002}, +month = may, +volume = {76}, +number = {5}, +issn = {0949-7714}, +url = {https://doi.org/10.1007/s00190-002-0216-2}, +doi = {10.1007/s00190-002-0216-2}, +pages = {279--299}, +publisher = {Springer Science and Business Media LLC}, +} +@article{Horne:1986ds, +author = {Horne, J H and Baliunas, S L}, +title = {{A prescription for period analysis of unevenly sampled time series}}, +journal = {The Astrophysical Journal}, +year = {1986}, +month = mar, +volume = {302}, +issn = {0004-637X}, +url = {https://doi.org/10.1086/164037}, +doi = {10.1086/164037}, +pages = {757}, +publisher = {American Astronomical Society}, +} +@article{Hsu:2017hd, +author = {Hsu, C-W and Velicogna, I}, +title = {{Detection of sea level fingerprints derived from GRACE gravity data}}, +journal = {Geophysical Research Letters}, +year = {2017}, +month = sep, +volume = {44}, +number = {17}, +issn = {0094-8276}, +url = {https://doi.org/10.1002/2017gl074070}, +doi = {10.1002/2017GL074070}, +pages = {8953--8961}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Ivins:2013cq, +author = {Ivins, E R and James, T S and Wahr, J and Schrama, E J O and Landerer, F W and Simon, K M}, +title = {{Antarctic contribution to sea level rise observed by GRACE with improved GIA correction}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2013}, +month = jun, +volume = {118}, +number = {6}, +issn = {2169-9313}, +url = {https://doi.org/10.1002/jgrb.50208}, +doi = {10.1002/jgrb.50208}, +pages = {3126--3141}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Jacob:2012eo, +author = {Jacob, T and Wahr, J and Gross, R and Swenson, S and A, G}, +title = {{Estimating geoid height change in North America: past, present and future}}, +journal = {Journal of Geodesy}, +year = {2012}, +month = may, +volume = {86}, +number = {5}, +issn = {0949-7714}, +url = {https://doi.org/10.1007/s00190-011-0522-7}, +doi = {10.1007/s00190-011-0522-7}, +pages = {337--358}, +publisher = {Springer Science and Business Media LLC}, +} +@article{Jacob:2012gv, +author = {Jacob, T and Wahr, J and Pfeffer, W and Swenson, S}, +title = {{Recent contributions of glaciers and ice caps to sea level rise}}, +journal = {Nature}, +year = {2012}, +month = feb, +volume = {482}, +number = {7386}, +issn = {0028-0836}, +url = {https://doi.org/10.1038/nature10847}, +doi = {10.1038/nature10847}, +pages = {514--518}, +publisher = {Springer Science and Business Media LLC}, +} +@book{Jacobs:1987vv, +author = {Jacobs, J A}, +title = {Geomagnetism}, +year = {1987}, +volume = {1}, +isbn = {978-0123786715}, +publisher = {Academic Press} +} +@techreport{Jekeli:1981vj, +author = {Jekeli, C}, +title = {{Alternative methods to smooth the Earth's gravity field}}, +year = {1981}, +number = {NASA Grant No. NGR 36-008-161, OSURF Proj. No. 783210}, +url = {https://ntrs.nasa.gov/citations/19820014947}, +publisher = {Reports of the Department of Geodetic Science and Surveying}, +address = {1958 Neil Avenue, Columbus, Ohio 43210}, +institution = {Ohio State University, Department of Geodetic Science and Surveying}, +} +@article{Joughin:2018ei, +author = {Joughin, I and Smith, B E and Howat, I}, +title = {{Greenland Ice Mapping Project: ice flow velocity variation at sub-monthly to decadal timescales}}, +journal = {The Cryosphere}, +year = {2018}, +month = jul, +volume = {12}, +number = {7}, +issn = {1994-0424}, +url = {https://doi.org/10.5194/tc-12-2211-2018}, +doi = {10.5194/tc-12-2211-2018}, +pages = {2211--2227}, +publisher = {Copernicus GmbH}, +} +@article{Kendall:2005ds, +author = {Kendall, R A and Mitrovica, J X and Milne, G A}, +title = {{On post-glacial sea level - II. Numerical formulation and comparative results on spherically symmetric models}}, +journal = {Geophysical Journal International}, +year = {2005}, +month = jun, +volume = {161}, +number = {3}, +issn = {0956-540X}, +url = {https://doi.org/10.1111/j.1365-246x.2005.02553.x}, +doi = {10.1111/j.1365-246X.2005.02553.x}, +pages = {679--706}, +publisher = {Oxford University Press (OUP)}, +} +@misc{Koenig:2019gs, +author = {Koenig, R and Schreiner, P and Dahle, C}, +title = {{Monthly estimates of C(2,0) generated by GFZ from SLR satellites based on GFZ GRACE/GRACE-FO RL06 background models}}, +year = {2019}, +version = {1.0}, +url = {http://doi.org/10.5880/GFZ.GRAVIS_06_C20_SLR}, +doi = {10.5880/GFZ.GRAVIS_06_C20_SLR}, +publisher = {GFZ Data Services}, +} +@book{Lambeck:1980um, +author = {Lambeck, K}, +title = {{The Earth's Variable Rotation: Geophysical Causes and Consequences}}, +year = {1980}, +version = {1}, +isbn = {9780521673303}, +url = {http://www.cambridge.org/9780521673303}, +publisher = {Cambridge University Press}, +address = {New York} +} +@article{Landerer:2012kf, +author = {Landerer, F W and Swenson, S C}, +title = {{Accuracy of scaled GRACE terrestrial water storage estimates}}, +journal = {Water Resources Research}, +year = {2012}, +month = apr, +volume = {48}, +number = {4}, +issn = {0043-1397}, +url = {https://doi.org/10.1029/2011wr011453}, +doi = {10.1029/2011WR011453}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Lomb:1976bo, +author = {Lomb, N R}, +title = {{Least-squares frequency analysis of unequally spaced data}}, +journal = {Astrophysics and Space Science}, +year = {1976}, +month = feb, +volume = {39}, +number = {2}, +issn = {0004-640X}, +url = {https://doi.org/10.1007/bf00648343}, +doi = {10.1007/BF00648343}, +pages = {447--462}, +publisher = {Springer Science and Business Media LLC}, +} +@article{Longman:1962ev, +author = {Longman, I M}, +title = {{A Green's function for determining the deformation of the Earth under surface mass loads: 1. Theory}}, +journal = {Journal of Geophysical Research}, +year = {1962}, +month = feb, +volume = {67}, +number = {2}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/jz067i002p00845}, +doi = {10.1029/JZ067i002p00845}, +pages = {845--850}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Loomis:2019dc, +author = {Loomis, B D and Rachlin, K E and Luthcke, S B}, +title = {{Improved Earth Oblateness Rate Reveals Increased Ice Sheet Losses and Mass-Driven Sea Level Rise}}, +journal = {Geophysical Research Letters}, +year = {2019}, +month = jun, +volume = {46}, +number = {12}, +issn = {0094-8276}, +url = {https://doi.org/10.1029/2019gl082929}, +doi = {10.1029/2019GL082929}, +pages = {6910--6917}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Loomis:2020bq, +author = {Loomis, B D and Rachlin, K E and Wiese, D N and Landerer, F W and Luthcke, S B}, +title = {{Replacing GRACE/GRACE-FO $C_{30}$ With Satellite Laser Ranging: Impacts on Antarctic Ice Sheet Mass Change}}, +journal = {Geophysical Research Letters}, +year = {2020}, +month = feb, +volume = {47}, +number = {3}, +issn = {0094-8276}, +url = {https://doi.org/10.1029/2019gl085488}, +doi = {10.1029/2019GL085488}, +publisher = {American Geophysical Union (AGU)}, +} +@techreport{Losch:2003ve, +author = {Losch, M and Seufer, V}, +title = {{How to Compute Geoid Undulations (Geoid Height Relative to a Given Reference Ellipsoid) from Spherical Harmonic Coefficients for Satellite Altimetry Applications}}, +year = {2003}, +month = dec, +url = {http://mitgcm.org/~mlosch/geoidcookbook/geoidcookbook.html}, +pages = {1--11}, +institution = {Alfred-Wegener-Institut f{\"u}r Polar- und Meeresforschung}, +} +@article{Luthcke:2013ep, +author = {Luthcke, S B and Sabaka, T J and Loomis, B D and Arendt, A A and McCarthy, J J and Camp, J}, +title = {{Antarctica, Greenland and Gulf of Alaska land-ice evolution from an iterated GRACE global mascon solution}}, +journal = {Journal of Glaciology}, +year = {2013}, +volume = {59}, +number = {216}, +issn = {0022-1430}, +url = {https://doi.org/10.3189/2013jog12j147}, +doi = {10.3189/2013JoG12J147}, +pages = {613--631}, +publisher = {International Glaciological Society}, +} +@article{Mitrovica:2003cq, +author = {Mitrovica, J X and Milne, G A}, +title = {{On post-glacial sea level: I. General theory}}, +journal = {Geophysical Journal International}, +year = {2003}, +month = aug, +volume = {154}, +number = {2}, +issn = {0956-540X}, +url = {https://doi.org/10.1046/j.1365-246x.2003.01942.x}, +doi = {10.1046/j.1365-246X.2003.01942.x}, +pages = {253--267}, +publisher = {Oxford University Press (OUP)}, +} +@misc{Mohlenkamp:2016vv, +author = {Mohlenkamp, M J}, +title = {{A User's Guide to Spherical Harmonics}}, +year = {2016}, +url = {http://www.ohiouniversityfaculty.com/mohlenka/research/uguide.pdf} +} +@book{Munk:1960uk, +author = {Munk, W H and MacDonald, G J F}, +title = {The Rotation of the Earth: A Geophysical Discussion}, +year = {1960}, +isbn = {9780521104067}, +url = {http://www.cambridge.org/9780521104067}, +doi = {10.1017/CB9780521104067}, +publisher = {Cambridge University Press}, +address = {New York} +} +@book{NRC:1997ea, +author = {{National Research Council}}, +title = {{Satellite Gravity and the Geosphere: Contributions to the Study of the Solid Earth and Its Fluid Envelopes}}, +year = {1997}, +isbn = {978-0-309-05792-9}, +url = {https://doi.org/10.17226/5767}, +doi = {10.17226/5767}, +publisher = {The National Academies Press}, +address = {Washington, DC}, +} +@article{Peltier:2015bo, +author = {Peltier, W R and Argus, D F and Drummond, R}, +title = {{Space geodesy constrains ice age terminal deglaciation: The global ICE-6G_C (VM5a) model}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2015}, +month = jan, +volume = {120}, +number = {1}, +issn = {2169-9356}, +url = {https://doi.org/10.1002/2014JB011176}, +doi = {10.1002/2014JB011176}, +pages = {450--487}, +note = {2014JB011176}, +keywords = {Satellite geodesy: results, Rheology of the lithosphere and mantle, Time variable gravity, Ocean/Earth/atmosphere/hydrosphere/cryosphere interactions, Global change from geodesy, glacial isostasy, space geodesy, mantle dynamics}, +} +@article{Peltier:2018dp, +author = {Peltier, W R and Argus, D F and Drummond, R}, +title = {{Comment on ``An Assessment of the ICE-6G\_C (VM5a) Glacial Isostatic Adjustment Model'' by Purcell et al.}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2018}, +month = feb, +volume = {123}, +number = {2}, +issn = {2169-9313}, +url = {https://doi.org/10.1002/2016jb013844}, +doi = {10.1002/2016JB013844}, +pages = {2019--2028}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Pollack:1973gi, +author = {Pollack, H N}, +title = {{Spherical harmonic representation of the gravitational potential of a point mass, a spherical cap, and a spherical rectangle}}, +journal = {Journal of Geophysical Research}, +year = {1973}, +month = apr, +volume = {78}, +number = {11}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/jb078i011p01760}, +doi = {10.1029/JB078i011p01760}, +pages = {1760--1768}, +publisher = {American Geophysical Union (AGU)}, +} +@book{Press:1988we, +author = {Press, W H}, +editor = {Flannery, B P and Teukolsky, S A and Vetterling, W T}, +title = {{Numerical Recipes in C}}, +year = {1988}, +url = {https://numerical.recipes}, +publisher = {Cambridge University Press}, +address = {New York, NY}, +} +@article{Rignot:2011ko, +author = {Rignot, E and Mouginot, J and Scheuchl, B}, +title = {{Ice Flow of the Antarctic Ice Sheet}}, +journal = {Science}, +year = {2011}, +month = sep, +volume = {333}, +number = {6048}, +issn = {0036-8075}, +url = {https://doi.org/10.1126/science.1208336}, +doi = {10.1126/science.1208336}, +pages = {1427--1430}, +publisher = {American Association for the Advancement of Science (AAAS)}, +} +@article{Rowlands:2010hj, +author = {Rowlands, D D and Luthcke, S B and McCarthy, J J and Klosko, S M and Chinn, D S and Lemoine, F G and Boy, J P and Sabaka, T J}, +title = {{Global mass flux solutions from GRACE: A comparison of parameter estimation strategies---Mass concentrations versus Stokes coefficients}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2010}, +month = jan, +volume = {115}, +number = {B1}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/2009jb006546}, +doi = {10.1029/2009JB006546}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Savitzky:1964bn, +author = {Savitzky, A and Golay, M J E}, +title = {{Smoothing and Differentiation of Data by Simplified Least Squares Procedures.}}, +journal = {Analytical Chemistry}, +year = {1964}, +month = jul, +volume = {36}, +number = {8}, +issn = {0003-2700}, +url = {https://doi.org/10.1021/ac60214a047}, +doi = {10.1021/ac60214a047}, +pages = {1627--1639}, +publisher = {American Chemical Society (ACS)}, +} +@article{Scargle:1982eu, +author = {Scargle, J D}, +title = {{Studies in astronomical time series analysis. II - Statistical aspects of spectral analysis of unevenly spaced data}}, +journal = {The Astrophysical Journal}, +year = {1982}, +month = dec, +volume = {263}, +issn = {0004-637X}, +url = {https://doi.org/10.1086/160554}, +doi = {10.1086/160554}, +pages = {835}, +publisher = {American Astronomical Society}, +} +@article{Seroussi:2011hi, +author = {Seroussi, H and Morlighem, M and Rignot, E and Larour, E and Aubry, D and Ben Dhia, H and Kristensen, S S}, +title = {{Ice flux divergence anomalies on 79north Glacier, Greenland}}, +journal = {Geophysical Research Letters}, +year = {2011}, +month = may, +volume = {38}, +number = {9}, +issn = {0094-8276}, +url = {https://doi.org/10.1029/2011gl047338}, +doi = {10.1029/2011GL047338}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Simpson:2009hg, +author = {Simpson, M J R and Milne, G A and Huybrechts, P and Long, A J}, +title = {{Calibrating a glaciological model of the Greenland ice sheet from the Last Glacial Maximum to present-day using field observations of relative sea level and ice extent}}, +journal = {Quaternary Science Reviews}, +year = {2009}, +month = aug, +volume = {28}, +number = {17-18}, +issn = {0277-3791}, +url = {https://doi.org/10.1016/j.quascirev.2009.03.004}, +doi = {10.1016/j.quascirev.2009.03.004}, +pages = {1631--1657}, +publisher = {Elsevier Ltd}, +} +@article{Sun:2016bf, +author = {Sun, Y and Ditmar, P and Riva, R}, +title = {{Observed changes in the Earth's dynamic oblateness from GRACE data and geophysical models}}, +journal = {Journal of Geodesy}, +year = {2016}, +volume = {90}, +number = {1}, +issn = {1432-1394}, +url = {https://doi.org/10.1007/s00190-015-0852-y}, +doi = {10.1007/s00190-015-0852-y}, +pages = {81--89}, +} +@article{Sun:2016hh, +author = {Sun, Y and Riva, R and Ditmar, P}, +title = {{Optimizing estimates of annual variations and trends in geocenter motion and J2 from a combination of GRACE data and geophysical models}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2016}, +volume = {121}, +number = {11}, +issn = {2169-9356}, +url = {https://doi.org/10.1002/2016JB013073}, +doi = {10.1002/2016JB013073}, +pages = {8352--8370}, +note = {2016JB013073}, +keywords = {Time variable gravity, Reference systems, Satellite geodesy: results, temporal gravity field variation, self-attraction and loading, Earth System Model, mass transport, glacial isostatic adjustment, satellite laser ranging}, +} +@article{Sutterley:2019bx, +author = {Sutterley, T C and Velicogna, I}, +title = {{Improved Estimates of Geocenter Variability from Time-Variable Gravity and Ocean Model Outputs}}, +journal = {Remote Sensing}, +year = {2019}, +month = sep, +volume = {11}, +number = {18}, +issn = {2072-4292}, +url = {https://doi.org/10.3390/rs11182108}, +doi = {10.3390/rs11182108}, +pages = {2108}, +publisher = {MDPI AG}, +} +@article{Sutterley:2020js, +author = {Sutterley, T C and Velicogna, I and Hsu, C-W}, +title = {{Self-Consistent Ice Mass Balance and Regional Sea Level From Time-Variable Gravity}}, +journal = {Earth and Space Science}, +year = {2020}, +month = mar, +volume = {7}, +number = {3}, +issn = {2333-5084}, +url = {https://doi.org/10.1029/2019ea000860}, +doi = {10.1029/2019EA000860}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Swenson:2002hs, +author = {Swenson, S and Wahr, J}, +title = {{Methods for inferring regional surface-mass anomalies from Gravity Recovery and Climate Experiment (GRACE) measurements of time-variable gravity}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2002}, +month = sep, +volume = {107}, +number = {B9}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/2001jb000576}, +doi = {10.1029/2001JB000576}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Swenson:2006hu, +author = {Swenson, S and Wahr, J}, +title = {{Post-processing removal of correlated errors in GRACE data}}, +journal = {Geophysical Research Letters}, +year = {2006}, +month = apr, +volume = {33}, +number = {8}, +issn = {0094-8276}, +url = {https://doi.org/10.1029/2005gl025285}, +doi = {10.1029/2005GL025285}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Swenson:2008cr, +author = {Swenson, S and Chambers, D and Wahr, J}, +title = {{Estimating geocenter variations from a combination of GRACE and ocean model output}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2008}, +month = aug, +volume = {113}, +number = {B8}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/2007jb005338}, +doi = {10.1029/2007JB005338}, +publisher = {American Geophysical Union (AGU)}, +} +@book{Szego:1939tn, +author = {Szeg{\"o}, G}, +title = {{Orthogonal Polynomials}}, +year = {1939}, +volume = {23}, +pages = {432}, +isbn = {978-0-8218-1023-1}, +url = {https://bookstore.ams.org/coll-23}, +publisher = {American Mathematical Society}, +} +@article{Tapley:2019cm, +author = {Tapley, B D and Watkins, M M and Flechtner, F and Reigber, C and Bettadpur, S and Rodell, M and Sasgen, I and Famiglietti, J S and Landerer, F W and Chambers, D P and Reager, J T and Gardner, A S and Save, H and Ivins, E R and Swenson, S C and Boening, C and Dahle, C and Wiese, D N and Dobslaw, H and Tamisiea, M E and Velicogna, I}, +title = {{Contributions of GRACE to understanding climate change}}, +journal = {Nature Climate Change}, +year = {2019}, +month = may, +volume = {9}, +number = {5}, +issn = {1758-678X}, +url = {https://doi.org/10.1038/s41558-019-0456-2}, +doi = {10.1038/s41558-019-0456-2}, +pages = {358--369}, +publisher = {Springer Science and Business Media LLC}, +} +@article{Tiwari:2009bx, +author = {Tiwari, V M and Wahr, J and Swenson, S}, +title = {{Dwindling groundwater resources in northern India, from satellite gravity observations}}, +journal = {Geophysical Research Letters}, +year = {2009}, +month = sep, +volume = {36}, +number = {18}, +issn = {0094-8276}, +url = {https://doi.org/10.1029/2009gl039401}, +doi = {10.1029/2009GL039401}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Toms:2003gv, +author = {Toms, J D and Lesperance, M L}, +title = {{PIECEWISE REGRESSION: A TOOL FOR IDENTIFYING ECOLOGICAL THRESHOLDS}}, +journal = {Ecology}, +year = {2003}, +month = aug, +volume = {84}, +number = {8}, +issn = {0012-9658}, +url = {https://doi.org/10.1890/02-0472}, +doi = {10.1890/02-0472}, +pages = {2034--2041}, +publisher = {Wiley}, +} +@article{Trupin:1992kp, +author = {Trupin, A S and Meier, M F and Wahr, J M}, +title = {{Effect of melting glaciers on the Earth's rotation and gravitational field: 1965--1984}}, +journal = {Geophysical Journal International}, +year = {1992}, +month = jan, +volume = {108}, +number = {1}, +issn = {0956-540X}, +url = {https://doi.org/10.1111/j.1365-246x.1992.tb00835.x}, +doi = {10.1111/j.1365-246X.1992.tb00835.x}, +pages = {1--15}, +publisher = {Oxford University Press (OUP)}, +} +@inproceedings{Tscherning:1982tu, +author = {Tscherning, C C and Poder, K}, +title = {{Some Geodetic Applications of Clenshaw Summation}}, +year = {1982}, +month = sep, +volume = {4}, +pages = {349--375}, +booktitle = {Eighth Symposium on Mathematical Geodesy}, +address = {Como, Italy}, +organization = {CNR, Gruppo nazionale della fisica matematica, Gruppo nazionale di geofisica della terra solida}, +} +@article{Velicogna:2009ft, +author = {Velicogna, I}, +title = {{Increasing rates of ice mass loss from the Greenland and Antarctic ice sheets revealed by GRACE}}, +journal = {Geophysical Research Letters}, +year = {2009}, +month = oct, +volume = {36}, +number = {19}, +issn = {0094-8276}, +url = {https://doi.org/10.1029/2009gl040222}, +doi = {10.1029/2009GL040222}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Velicogna:2014km, +author = {Velicogna, I and Sutterley, T C and van den Broeke, M R}, +title = {{Regional acceleration in ice mass loss from Greenland and Antarctica using GRACE time-variable gravity data}}, +journal = {Geophysical Research Letters}, +year = {2014}, +month = nov, +volume = {41}, +number = {22}, +issn = {0094-8276}, +url = {https://doi.org/10.1002/2014gl061052}, +doi = {10.1002/2014GL061052}, +pages = {8130--8137}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Wahr:1981ea, +author = {Wahr, J M}, +title = {{Body tides on an elliptical, rotating, elastic and oceanless Earth}}, +journal = {Geophysical Journal of the Royal Astronomical Society}, +year = {1981}, +volume = {64}, +number = {3}, +issn = {1365-246X}, +url = {https://doi.org/10.1111/j.1365-246X.1981.tb02690.x}, +doi = {10.1111/j.1365-246X.1981.tb02690.x}, +pages = {677--703}, +publisher = {Blackwell Publishing Ltd}, +} +@article{Wahr:1985gr, +author = {Wahr, J M}, +title = {{Deformation induced by polar motion}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {1985}, +month = sep, +volume = {90}, +number = {B11}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/jb090ib11p09363}, +doi = {10.1029/JB090iB11p09363}, +pages = {9363--9368}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Wahr:1998hy, +author = {Wahr, J and Molenaar, M and Bryan, F}, +title = {{Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {1998}, +month = dec, +volume = {103}, +number = {B12}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/98jb02844}, +doi = {10.1029/98JB02844}, +pages = {30205--30229}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Wahr:2000ek, +author = {Wahr, J and Wingham, D and Bentley, C}, +title = {{A method of combining ICESat and GRACE satellite data to constrain Antarctic mass balance}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2000}, +month = jul, +volume = {105}, +number = {B7}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/2000jb900113}, +doi = {10.1029/2000JB900113}, +pages = {16279--16294}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Wahr:2002ie, +author = {Wahr, J M and Jayne, S R and Bryan, F O}, +title = {{A method of inferring changes in deep ocean currents from satellite measurements of time-variable gravity}}, +journal = {Journal of Geophysical Research: Oceans}, +year = {2002}, +month = dec, +volume = {107}, +number = {C12}, +issn = {0148-0227}, +url = {https://doi.org/10.1029/2001jc001274}, +doi = {10.1029/2001JC001274}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Wahr:2006bx, +author = {Wahr, J and Swenson, S and Velicogna, I}, +title = {{Accuracy of GRACE mass estimates}}, +journal = {Geophysical Research Letters}, +year = {2006}, +month = mar, +volume = {33}, +number = {6}, +issn = {0094-8276}, +url = {https://doi.org/10.1029/2005gl025305}, +doi = {10.1029/2005GL025305}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Wahr:2015dg, +author = {Wahr, J and Nerem, R and Bettadpur, S V}, +title = {{The pole tide and its effect on GRACE time-variable gravity measurements: Implications for estimates of surface mass variations}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2015}, +month = jun, +volume = {120}, +number = {6}, +issn = {2169-9313}, +url = {https://doi.org/10.1002/2015jb011986}, +doi = {10.1002/2015JB011986}, +pages = {4597--4615}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Wang:2012gc, +author = {Wang, H and Xiang, L and Jia, L and Jiang, L and Wang, Z and Hu, B and Gao, P}, +title = {{Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0}}, +journal = {Computers \& Geosciences}, +year = {2012}, +month = dec, +volume = {49}, +issn = {0098-3004}, +url = {https://doi.org/10.1016/j.cageo.2012.06.022}, +doi = {10.1016/j.cageo.2012.06.022}, +pages = {190--199}, +publisher = {Elsevier BV}, +} +@article{Watkins:2015jl, +author = {Watkins, M M and Wiese, D N and Yuan, D-N and Boening, C and Landerer, F W}, +title = {{Improved methods for observing Earth's time variable mass distribution with GRACE using spherical cap mascons}}, +journal = {Journal of Geophysical Research: Solid Earth}, +year = {2015}, +month = apr, +volume = {120}, +number = {4}, +issn = {2169-9313}, +url = {https://doi.org/10.1002/2014jb011547}, +doi = {10.1002/2014JB011547}, +pages = {2648--2671}, +publisher = {American Geophysical Union (AGU)}, +} +@article{Whitehouse:2012jj, +author = {Whitehouse, P L and Bentley, M J and Milne, G A and King, M A and Thomas, I D}, +title = {{A new glacial isostatic adjustment model for Antarctica: calibrated and tested using observations of relative sea-level change and present-day uplift rates}}, +journal = {Geophysical Journal International}, +year = {2012}, +month = sep, +volume = {190}, +number = {3}, +issn = {0956-540X}, +url = {https://doi.org/10.1111/j.1365-246x.2012.05557.x}, +doi = {10.1111/j.1365-246X.2012.05557.x}, +pages = {1464--1482}, +publisher = {Oxford University Press (OUP)}, +} +@article{Wu:2010dq, +author = {Wu, X and Heflin, M B and Schotman, H and Vermeersen, B L and Dong, D and Gross, R S and Ivins, E R and Moore, A W and Owen, S E}, +title = {{Simultaneous estimation of global present-day water transport and glacial isostatic adjustment}}, +journal = {Nature Geoscience}, +year = {2010}, +month = sep, +volume = {3}, +number = {9}, +issn = {1752-0894}, +url = {https://doi.org/10.1038/ngeo938}, +doi = {10.1038/ngeo938}, +pages = {642--646}, +publisher = {Springer Science and Business Media LLC}, +} diff --git a/doc/source/api_reference/calc_degree_one.rst b/doc/source/api_reference/calc_degree_one.rst index 2bd076a3..652db560 100644 --- a/doc/source/api_reference/calc_degree_one.rst +++ b/doc/source/api_reference/calc_degree_one.rst @@ -2,7 +2,7 @@ calc_degree_one.py ================== -- Calculates degree 1 variations using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations [Swenson2008]_ [Sutterley2019]_. +- Calculates degree 1 variations using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations :cite:p:`Swenson:2008cr` :cite:p:`Sutterley:2019bx`. `Source code`__ @@ -19,25 +19,25 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --kl -k : @after - * ``None``: use derived values from [Trupin1992]_ [Blewett2003]_. + * ``None``: use derived values from :cite:p:`Trupin:1992kp` :cite:p:`Blewitt:2003bz`. --gia -G : @after - * ``'IJ05-R2'``: `Ivins R2 GIA Models `_ - * ``'W12a'``: `Whitehouse GIA Models `_ - * ``'SM09'``: `Simpson/Milne GIA Models `_ - * ``'ICE6G'``: `ICE-6G GIA Models `_ - * ``'Wu10'``: `Wu (2010) GIA Correction `_ - * ``'AW13-ICE6G'``: `Geruo A ICE-6G GIA Models `_ - * ``'AW13-IJ05'``: `Geruo A IJ05-R2 GIA Models `_ - * ``'Caron'``: `Caron JPL GIA Assimilation `_ - * ``'ICE6G-D'``: `ICE-6G Version-D GIA Models `_ + * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq` + * ``'W12a'``: Whitehouse GIA Models :cite:p:`Whitehouse:2012jj` + * ``'SM09'``: Simpson/Milne GIA Models :cite:p:`Simpson:2009hg` + * ``'ICE6G'``: ICE-6G GIA Models :cite:p:`Peltier:2015bo` + * ``'Wu10'``: Wu (2010) GIA Correction :cite:p:`Wu:2010dq` + * ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models :cite:p:`A:2013kh` + * ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models :cite:p:`A:2013kh` + * ``'Caron'``: Caron JPL GIA Assimilation :cite:p:`Caron:2018ba` + * ``'ICE6G-D'``: ICE-6G Version-D GIA Models :cite:p:`Peltier:2018dp` * ``'ascii'``: reformatted GIA in ascii format * ``'netCDF4'``: reformatted GIA in netCDF4 format * ``'HDF5'``: reformatted GIA in HDF5 format @@ -99,21 +99,4 @@ Calling Sequence * ``'gelss'``: singular value decomposition (SVD) solution * ``'gelsd'``: singular value decomposition (SVD) solution with a divide and conquer method -References -########## - -.. [Blewett2003] G. Blewitt, "Self-consistency in reference frames, geocenter definition, and surface loading of the solid Earth", *Journal of Geophysical Research: Solid Earth*, 108(B2), 2103, (2003). `doi: 10.1029/2002JB002082 `_ - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Sutterley2019] T. C. Sutterley and I. Velicogna, "Improved Estimates of Geocenter Variability from Time-Variable Gravity and Ocean Model Outputs", *Remote Sensing*, 11(18), 2108, (2019). `doi: 10.3390/rs11182108 `_ - -.. [Swenson2008] S. Swenson, D. Chambers, and J. Wahr, "Estimating geocenter variations from a combination of GRACE and ocean model output", *Journal of Geophysical Research: Solid Earth*, 113(B08410), (2008). `doi: 10.1029/2007JB005338 `_ - -.. [Trupin1992] A. S. Trupin, M. F. Meier, and J. Wahr, "Effect of melting glaciers on the Earth's rotation and gravitational field: 1965--1984", *Geophysical Journal International*, 108(1), (1992). `doi: 10.1111/j.1365-246X.1992.tb00835.x `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - .. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN diff --git a/doc/source/api_reference/calc_harmonic_resolution.rst b/doc/source/api_reference/calc_harmonic_resolution.rst index cabc22b6..d79b2018 100644 --- a/doc/source/api_reference/calc_harmonic_resolution.rst +++ b/doc/source/api_reference/calc_harmonic_resolution.rst @@ -2,7 +2,7 @@ calc_harmonic_resolution.py =========================== -- Calculates the spatial resolution that can be resolved by the spherical harmonics of a certain degree [Barthelmes2013]_ [HofmannWellenhof2006]_ +- Calculates the spatial resolution that can be resolved by the spherical harmonics of a certain degree :cite:p:`Barthelmes:2013fy` :cite:p:`HofmannWellenhof:2006hy` - Default method uses the smallest half-wavelength that can be resolved - Secondary method calculates the smallest possible bump that can be resolved @@ -19,10 +19,3 @@ Calling Sequence :prog: calc_harmonic_resolution.py :nodescription: :nodefault: - -References -########## - -.. [Barthelmes2013] F. Barthelmes, "Definition of Functionals of the Geopotential and Their Calculation from Spherical Harmonic Models", GeoForschungsZentrum Scientific Technical Report, STR09/02, (2013). `doi: 10.2312/GFZ.b103-0902-26 `_ - -.. [HofmannWellenhof2006] B. Hofmann-Wellenhof and H. Moritz, *Physical Geodesy*, 2nd Edition, 403 pp., (2006). `doi: 10.1007/978-3-211-33545-1 `_ diff --git a/doc/source/api_reference/calc_mascon.rst b/doc/source/api_reference/calc_mascon.rst index ab25b5c3..3638ff94 100644 --- a/doc/source/api_reference/calc_mascon.rst +++ b/doc/source/api_reference/calc_mascon.rst @@ -4,9 +4,9 @@ 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 [Jekeli1981]_ [Swenson2006]_ -- Calculates a time-series of regional mass anomalies through a least-squares mascon procedure following [Tiwari2009]_ [Jacob2012]_ -- Calculates the regional mascon errors following [Wahr2006]_ +- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu` +- Calculates a time-series of regional mass anomalies through a least-squares mascon procedure following :cite:p:`Tiwari:2009bx` :cite:p:`Jacob:2012gv` +- Calculates the regional mascon errors following :cite:p:`Wahr:2006bx` `Source code`__ @@ -23,11 +23,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -35,15 +35,15 @@ Calling Sequence * ``'CE'``: Center of Mass of Solid Earth --gia -G : @after - * ``'IJ05-R2'``: `Ivins R2 GIA Models `_ - * ``'W12a'``: `Whitehouse GIA Models `_ - * ``'SM09'``: `Simpson/Milne GIA Models `_ - * ``'ICE6G'``: `ICE-6G GIA Models `_ - * ``'Wu10'``: `Wu (2010) GIA Correction `_ - * ``'AW13-ICE6G'``: `Geruo A ICE-6G GIA Models `_ - * ``'AW13-IJ05'``: `Geruo A IJ05-R2 GIA Models `_ - * ``'Caron'``: `Caron JPL GIA Assimilation `_ - * ``'ICE6G-D'``: `ICE-6G Version-D GIA Models `_ + * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq` + * ``'W12a'``: Whitehouse GIA Models :cite:p:`Whitehouse:2012jj` + * ``'SM09'``: Simpson/Milne GIA Models :cite:p:`Simpson:2009hg` + * ``'ICE6G'``: ICE-6G GIA Models :cite:p:`Peltier:2015bo` + * ``'Wu10'``: Wu (2010) GIA Correction :cite:p:`Wu:2010dq` + * ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models :cite:p:`A:2013kh` + * ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models :cite:p:`A:2013kh` + * ``'Caron'``: Caron JPL GIA Assimilation :cite:p:`Caron:2018ba` + * ``'ICE6G-D'``: ICE-6G Version-D GIA Models :cite:p:`Peltier:2018dp` * ``'ascii'``: reformatted GIA in ascii format * ``'netCDF4'``: reformatted GIA in netCDF4 format * ``'HDF5'``: reformatted GIA in HDF5 format @@ -117,23 +117,4 @@ Calling Sequence * ``'gelss'``: singular value decomposition (SVD) solution * ``'gelsd'``: singular value decomposition (SVD) solution with a divide and conquer method -References -########## - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Jacob2012] T. Jacob, J. Wahr, W. T. Pfeffer, and S. Swenson, "Recent contributions of glaciers and ice caps to sea level rise", *Nature*, 482, 514--518, (2012). `doi: 10.1038/nature10847 `_ - -.. [Jekeli1981] C. Jekeli, "Alternative Methods to Smooth the Earth's Gravity Field", NASA Grant No. NGR 36-008-161, OSURF Proj. No. 783210, 48 pp., (1981). - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Tiwari2009] V. M. Tiwari, J. Wahr, and S. Swenson, "Dwindling groundwater resources in northern India, from satellite gravity observations", *Geophysical Research Letters*, 36(L18401), (2009). `doi: 10.1029/2009GL039401 `_ - -.. [Wahr2006] J. Wahr, S. Swenson, and I. Velicogna, "Accuracy of GRACE mass estimates", Geophysical Research Letters, 33(L06401), (2006). `doi: 10.1029/2005GL025305 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - .. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN diff --git a/doc/source/api_reference/calc_sensitivity_kernel.rst b/doc/source/api_reference/calc_sensitivity_kernel.rst index eeb1c800..08411dbf 100644 --- a/doc/source/api_reference/calc_sensitivity_kernel.rst +++ b/doc/source/api_reference/calc_sensitivity_kernel.rst @@ -2,7 +2,7 @@ calc_sensitivity_kernel.py ========================== -- Calculates spatial sensitivity kernels through a least-squares mascon procedure following [Tiwari2009]_ [Jacob2012]_ +- Calculates spatial sensitivity kernels through a least-squares mascon procedure following :cite:p:`Tiwari:2009bx` :cite:p:`Jacob:2012gv` `Source code`__ @@ -19,11 +19,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -42,16 +42,3 @@ Calling Sequence * ``'gelsy'``: complete orthogonal factorization solution * ``'gelss'``: singular value decomposition (SVD) solution * ``'gelsd'``: singular value decomposition (SVD) solution with a divide and conquer method - -References -########## - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Jacob2012] T. Jacob, J. Wahr, W. T. Pfeffer, and S. Swenson, "Recent contributions of glaciers and ice caps to sea level rise", *Nature*, 482, 514--518, (2012). `doi: 10.1038/nature10847 `_ - -.. [Tiwari2009] V. M. Tiwari, J. Wahr, and S. Swenson, "Dwindling groundwater resources in northern India, from satellite gravity observations", *Geophysical Research Letters*, 36(L18401), (2009). `doi: 10.1029/2009GL039401 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ diff --git a/doc/source/api_reference/combine_harmonics.rst b/doc/source/api_reference/combine_harmonics.rst index 6a670c84..d7a383e4 100644 --- a/doc/source/api_reference/combine_harmonics.rst +++ b/doc/source/api_reference/combine_harmonics.rst @@ -2,7 +2,7 @@ combine_harmonics.py ==================== -- Converts a file from the spherical harmonic domain into the spatial domain [Wahr1998]_ +- Converts a file from the spherical harmonic domain into the spatial domain :cite:p:`Wahr:1998hy` `Source code`__ @@ -19,11 +19,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -43,17 +43,4 @@ Calling Sequence * ``2``: (degree spacing/2) * ``3``: non-global grid (set with defined bounds) -References -########## - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - .. |mu| unicode:: U+03BC .. GREEK SMALL LETTER MU diff --git a/doc/source/api_reference/convert_harmonics.rst b/doc/source/api_reference/convert_harmonics.rst index c29c9eec..ca37c135 100644 --- a/doc/source/api_reference/convert_harmonics.rst +++ b/doc/source/api_reference/convert_harmonics.rst @@ -2,7 +2,7 @@ convert_harmonics.py ==================== -- Converts a file from the spatial domain into the spherical harmonic domain [Wahr1998]_ +- Converts a file from the spatial domain into the spherical harmonic domain :cite:p:`Wahr:1998hy` `Source code`__ @@ -19,11 +19,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -38,14 +38,3 @@ Calling Sequence --interval -I : @after * ``1``: (0:360, 90:-90) * ``2``: (degree spacing/2) - -References -########## - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ diff --git a/doc/source/api_reference/dealiasing_global_uplift.rst b/doc/source/api_reference/dealiasing_global_uplift.rst index 6066ada4..84b84ad5 100644 --- a/doc/source/api_reference/dealiasing_global_uplift.rst +++ b/doc/source/api_reference/dealiasing_global_uplift.rst @@ -2,7 +2,7 @@ dealiasing_global_uplift.py =========================== -- Reads GRACE/GRACE-FO level-1b dealiasing data files for global atmospheric and oceanic loading and estimates anomalies in elastic crustal uplift [Davis2004]_ [Wahr1998]_ +- Reads GRACE/GRACE-FO level-1b dealiasing data files for global atmospheric and oceanic loading and estimates anomalies in elastic crustal uplift :cite:p:`Davis:2004il` :cite:p:`Wahr:1998hy` `Source code`__ @@ -19,11 +19,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -34,19 +34,3 @@ Calling Sequence * ``1``: (0:360, 90:-90) * ``2``: (degree spacing/2) * ``3``: non-global grid (set with defined bounds) - -References -########## - -.. [Davis2004] J. L. Davis et al., "Climate-driven deformation of the solid Earth from GRACE and GPS", *Geophysical Research Letters*, 31(L24605), (2004). `doi: 10.1029/2004GL021435 `_ - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - diff --git a/doc/source/api_reference/destripe_harmonics.rst b/doc/source/api_reference/destripe_harmonics.rst index 25768572..88ee5d7f 100644 --- a/doc/source/api_reference/destripe_harmonics.rst +++ b/doc/source/api_reference/destripe_harmonics.rst @@ -2,7 +2,7 @@ destripe_harmonics ================== -- Filters spherical harmonic coefficients for correlated "striping" errors following [Swenson2006]_ +- Filters spherical harmonic coefficients for correlated "striping" errors following :cite:p:`Swenson:2006hu` Calling Sequence ################ diff --git a/doc/source/api_reference/grace_raster_grids.rst b/doc/source/api_reference/grace_raster_grids.rst index bf206217..514353a8 100644 --- a/doc/source/api_reference/grace_raster_grids.rst +++ b/doc/source/api_reference/grace_raster_grids.rst @@ -4,8 +4,8 @@ grace_raster_grids.py - Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports projected spatial fields - Correct spherical harmonics with the specified GIA model group -- Filters and smooths data with specified processing algorithms [Jekeli1981]_ [Swenson2006]_ -- Converts data to specified units and performs a Clenshaw harmonic summation to convert to the spatial domain [Holmes2002]_ [Tscherning1982]_ +- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu` +- Converts data to specified units and performs a Clenshaw harmonic summation to convert to the spatial domain :cite:p:`Holmes:2002ff` :cite:p:`Tscherning:1982tu` `Source code`__ @@ -22,11 +22,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -34,15 +34,15 @@ Calling Sequence * ``'CE'``: Center of Mass of Solid Earth --gia -G : @after - * ``'IJ05-R2'``: `Ivins R2 GIA Models `_ - * ``'W12a'``: `Whitehouse GIA Models `_ - * ``'SM09'``: `Simpson/Milne GIA Models `_ - * ``'ICE6G'``: `ICE-6G GIA Models `_ - * ``'Wu10'``: `Wu (2010) GIA Correction `_ - * ``'AW13-ICE6G'``: `Geruo A ICE-6G GIA Models `_ - * ``'AW13-IJ05'``: `Geruo A IJ05-R2 GIA Models `_ - * ``'Caron'``: `Caron JPL GIA Assimilation `_ - * ``'ICE6G-D'``: `ICE-6G Version-D GIA Models `_ + * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq` + * ``'W12a'``: Whitehouse GIA Models :cite:p:`Whitehouse:2012jj` + * ``'SM09'``: Simpson/Milne GIA Models :cite:p:`Simpson:2009hg` + * ``'ICE6G'``: ICE-6G GIA Models :cite:p:`Peltier:2015bo` + * ``'Wu10'``: Wu (2010) GIA Correction :cite:p:`Wu:2010dq` + * ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models :cite:p:`A:2013kh` + * ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models :cite:p:`A:2013kh` + * ``'Caron'``: Caron JPL GIA Assimilation :cite:p:`Caron:2018ba` + * ``'ICE6G-D'``: ICE-6G Version-D GIA Models :cite:p:`Peltier:2018dp` * ``'ascii'``: reformatted GIA in ascii format * ``'netCDF4'``: reformatted GIA in netCDF4 format * ``'HDF5'``: reformatted GIA in HDF5 format @@ -113,23 +113,6 @@ Calling Sequence --projection : @after * ``4326``: latitude and longitude coordinates on WGS84 reference ellipsoid -References -########## - -.. [Holmes2002] S. A. Holmes and W. E. Featherstone, "A unified approach to the Clenshaw summation and the recursive computation of very high degree and order normalised associated Legendre functions", *Journal of Geodesy*, 76, 279--299, (2002). `doi: 10.1007/s00190-002-0216-2 `_ - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Jekeli1981] C. Jekeli, "Alternative Methods to Smooth the Earth's Gravity Field", NASA Grant No. NGR 36-008-161, OSURF Proj. No. 783210, 48 pp., (1981). - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Tscherning1982] C. C. Tscherning and K. Poder, "Some Geodetic Applications of Clenshaw Summation", *Bollettino di Geodesia e Scienze*, 4, 349--375, (1982). - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - .. |mu| unicode:: U+03BC .. GREEK SMALL LETTER MU .. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN diff --git a/doc/source/api_reference/grace_spatial_error.rst b/doc/source/api_reference/grace_spatial_error.rst index 9e179790..745eab9b 100644 --- a/doc/source/api_reference/grace_spatial_error.rst +++ b/doc/source/api_reference/grace_spatial_error.rst @@ -2,9 +2,9 @@ grace_spatial_error.py ====================== -- Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports spatial error field following [Wahr2006]_ -- Filters and smooths data with specified processing algorithms [Jekeli1981]_ [Swenson2006]_ -- Converts data to specified units and performs a spherical harmonic summation to convert error field to the spatial domain [Wahr1998]_ +- Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports spatial error field following :cite:p:`Wahr:2006bx` +- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu` +- Converts data to specified units and performs a spherical harmonic summation to convert error field to the spatial domain :cite:p:`Wahr:1998hy` `Source code`__ @@ -21,11 +21,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -94,23 +94,6 @@ Calling Sequence * ``2``: (degree spacing/2) * ``3``: non-global grid (set with defined bounds) -References -########## - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Jekeli1981] C. Jekeli, "Alternative Methods to Smooth the Earth's Gravity Field", NASA Grant No. NGR 36-008-161, OSURF Proj. No. 783210, 48 pp., (1981). - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wahr2006] J. Wahr, S. Swenson, and I. Velicogna, "Accuracy of GRACE mass estimates", Geophysical Research Letters, 33(L06401), (2006). `doi: 10.1029/2005GL025305 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - .. |mu| unicode:: U+03BC .. GREEK SMALL LETTER MU .. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN diff --git a/doc/source/api_reference/grace_spatial_maps.rst b/doc/source/api_reference/grace_spatial_maps.rst index 04c5d1c0..d992268e 100644 --- a/doc/source/api_reference/grace_spatial_maps.rst +++ b/doc/source/api_reference/grace_spatial_maps.rst @@ -4,8 +4,8 @@ grace_spatial_maps.py - Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports monthly spatial fields - Correct spherical harmonics with the specified GIA model group -- Filters and smooths data with specified processing algorithms [Jekeli1981]_ [Swenson2006]_ -- Converts data to specified units and performs a spherical harmonic summation to convert to the spatial domain [Wahr1998]_ +- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu` +- Converts data to specified units and performs a spherical harmonic summation to convert to the spatial domain :cite:p:`Wahr:1998hy` `Source code`__ @@ -22,11 +22,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -34,15 +34,15 @@ Calling Sequence * ``'CE'``: Center of Mass of Solid Earth --gia -G : @after - * ``'IJ05-R2'``: `Ivins R2 GIA Models `_ - * ``'W12a'``: `Whitehouse GIA Models `_ - * ``'SM09'``: `Simpson/Milne GIA Models `_ - * ``'ICE6G'``: `ICE-6G GIA Models `_ - * ``'Wu10'``: `Wu (2010) GIA Correction `_ - * ``'AW13-ICE6G'``: `Geruo A ICE-6G GIA Models `_ - * ``'AW13-IJ05'``: `Geruo A IJ05-R2 GIA Models `_ - * ``'Caron'``: `Caron JPL GIA Assimilation `_ - * ``'ICE6G-D'``: `ICE-6G Version-D GIA Models `_ + * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq` + * ``'W12a'``: Whitehouse GIA Models :cite:p:`Whitehouse:2012jj` + * ``'SM09'``: Simpson/Milne GIA Models :cite:p:`Simpson:2009hg` + * ``'ICE6G'``: ICE-6G GIA Models :cite:p:`Peltier:2015bo` + * ``'Wu10'``: Wu (2010) GIA Correction :cite:p:`Wu:2010dq` + * ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models :cite:p:`A:2013kh` + * ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models :cite:p:`A:2013kh` + * ``'Caron'``: Caron JPL GIA Assimilation :cite:p:`Caron:2018ba` + * ``'ICE6G-D'``: ICE-6G Version-D GIA Models :cite:p:`Peltier:2018dp` * ``'ascii'``: reformatted GIA in ascii format * ``'netCDF4'``: reformatted GIA in netCDF4 format * ``'HDF5'``: reformatted GIA in HDF5 format @@ -117,21 +117,6 @@ Calling Sequence * ``2``: (degree spacing/2) * ``3``: non-global grid (set with defined bounds) -References -########## - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Jekeli1981] C. Jekeli, "Alternative Methods to Smooth the Earth's Gravity Field", NASA Grant No. NGR 36-008-161, OSURF Proj. No. 783210, 48 pp., (1981). - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - .. |mu| unicode:: U+03BC .. GREEK SMALL LETTER MU .. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN diff --git a/doc/source/api_reference/mascon_reconstruct.rst b/doc/source/api_reference/mascon_reconstruct.rst index d87c2fbf..39f33fc5 100644 --- a/doc/source/api_reference/mascon_reconstruct.rst +++ b/doc/source/api_reference/mascon_reconstruct.rst @@ -19,11 +19,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -31,15 +31,15 @@ Calling Sequence * ``'CE'``: Center of Mass of Solid Earth --gia -G : @after - * ``'IJ05-R2'``: `Ivins R2 GIA Models `_ - * ``'W12a'``: `Whitehouse GIA Models `_ - * ``'SM09'``: `Simpson/Milne GIA Models `_ - * ``'ICE6G'``: `ICE-6G GIA Models `_ - * ``'Wu10'``: `Wu (2010) GIA Correction `_ - * ``'AW13-ICE6G'``: `Geruo A ICE-6G GIA Models `_ - * ``'AW13-IJ05'``: `Geruo A IJ05-R2 GIA Models `_ - * ``'Caron'``: `Caron JPL GIA Assimilation `_ - * ``'ICE6G-D'``: `ICE-6G Version-D GIA Models `_ + * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq` + * ``'W12a'``: Whitehouse GIA Models :cite:p:`Whitehouse:2012jj` + * ``'SM09'``: Simpson/Milne GIA Models :cite:p:`Simpson:2009hg` + * ``'ICE6G'``: ICE-6G GIA Models :cite:p:`Peltier:2015bo` + * ``'Wu10'``: Wu (2010) GIA Correction :cite:p:`Wu:2010dq` + * ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models :cite:p:`A:2013kh` + * ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models :cite:p:`A:2013kh` + * ``'Caron'``: Caron JPL GIA Assimilation :cite:p:`Caron:2018ba` + * ``'ICE6G-D'``: ICE-6G Version-D GIA Models :cite:p:`Peltier:2018dp` * ``'ascii'``: reformatted GIA in ascii format * ``'netCDF4'``: reformatted GIA in netCDF4 format * ``'HDF5'``: reformatted GIA in HDF5 format diff --git a/doc/source/api_reference/monte_carlo_degree_one.rst b/doc/source/api_reference/monte_carlo_degree_one.rst index 861c4d1f..6979e814 100644 --- a/doc/source/api_reference/monte_carlo_degree_one.rst +++ b/doc/source/api_reference/monte_carlo_degree_one.rst @@ -2,8 +2,8 @@ monte_carlo_degree_one.py ========================= -- Estimates uncertainties in degree 1 using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations in a Monte Carlo scheme [Swenson2008]_ [Sutterley2019]_. -- Calculates the estimated spherical harmonic errors following [Wahr2006]_ +- Estimates uncertainties in degree 1 using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations in a Monte Carlo scheme :cite:p:`Swenson:2008cr` :cite:p:`Sutterley:2019bx`. +- Calculates the estimated spherical harmonic errors following :cite:p:`Wahr:2006bx` `Source code`__ @@ -20,25 +20,25 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --kl -k : @after - * ``None``: use derived values from [Trupin1992]_ [Blewett2003]_. + * ``None``: use derived values from :cite:p:`Trupin:1992kp` :cite:p:`Blewitt:2003bz`. --gia -G : @after - * ``'IJ05-R2'``: `Ivins R2 GIA Models `_ - * ``'W12a'``: `Whitehouse GIA Models `_ - * ``'SM09'``: `Simpson/Milne GIA Models `_ - * ``'ICE6G'``: `ICE-6G GIA Models `_ - * ``'Wu10'``: `Wu (2010) GIA Correction `_ - * ``'AW13-ICE6G'``: `Geruo A ICE-6G GIA Models `_ - * ``'AW13-IJ05'``: `Geruo A IJ05-R2 GIA Models `_ - * ``'Caron'``: `Caron JPL GIA Assimilation `_ - * ``'ICE6G-D'``: `ICE-6G Version-D GIA Models `_ + * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq` + * ``'W12a'``: Whitehouse GIA Models :cite:p:`Whitehouse:2012jj` + * ``'SM09'``: Simpson/Milne GIA Models :cite:p:`Simpson:2009hg` + * ``'ICE6G'``: ICE-6G GIA Models :cite:p:`Peltier:2015bo` + * ``'Wu10'``: Wu (2010) GIA Correction :cite:p:`Wu:2010dq` + * ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models :cite:p:`A:2013kh` + * ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models :cite:p:`A:2013kh` + * ``'Caron'``: Caron JPL GIA Assimilation :cite:p:`Caron:2018ba` + * ``'ICE6G-D'``: ICE-6G Version-D GIA Models :cite:p:`Peltier:2018dp` * ``'ascii'``: reformatted GIA in ascii format * ``'netCDF4'``: reformatted GIA in netCDF4 format * ``'HDF5'``: reformatted GIA in HDF5 format @@ -100,23 +100,4 @@ Calling Sequence * ``'gelss'``: singular value decomposition (SVD) solution * ``'gelsd'``: singular value decomposition (SVD) solution with a divide and conquer method -References -########## - -.. [Blewett2003] G. Blewitt, "Self-consistency in reference frames, geocenter definition, and surface loading of the solid Earth", *Journal of Geophysical Research: Solid Earth*, 108(B2), 2103, (2003). `doi: 10.1029/2002JB002082 `_ - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Sutterley2019] T. C. Sutterley and I. Velicogna, "Improved Estimates of Geocenter Variability from Time-Variable Gravity and Ocean Model Outputs", *Remote Sensing*, 11(18), 2108, (2019). `doi: 10.3390/rs11182108 `_ - -.. [Swenson2008] S. Swenson, D. Chambers, and J. Wahr, "Estimating geocenter variations from a combination of GRACE and ocean model output", *Journal of Geophysical Research: Solid Earth*, 113(B08410), (2008). `doi: 10.1029/2007JB005338 `_ - -.. [Trupin1992] A. S. Trupin, M. F. Meier, and J. Wahr, "Effect of melting glaciers on the Earth's rotation and gravitational field: 1965--1984", *Geophysical Journal International*, 108(1), (1992). `doi: 10.1111/j.1365-246X.1992.tb00835.x `_ - -.. [Wahr2006] J. Wahr, S. Swenson, and I. Velicogna, "Accuracy of GRACE mass estimates", Geophysical Research Letters, 33(L06401), (2006). `doi: 10.1029/2005GL025305 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - .. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN diff --git a/doc/source/api_reference/ocean_stokes.rst b/doc/source/api_reference/ocean_stokes.rst index d332da4d..4c84ce82 100644 --- a/doc/source/api_reference/ocean_stokes.rst +++ b/doc/source/api_reference/ocean_stokes.rst @@ -3,7 +3,7 @@ ocean_stokes ============ - Reads a land-sea mask and converts to a series of spherical harmonics -- `netCDF4 land-sea mask files `_ from [Sutterley2020]_ +- `netCDF4 land-sea mask files `_ from :cite:p:`Sutterley:2020js` * updated 1.0, 0.5 and 0.25 degree masks from `ORNL as part of ISLSCP `_ Calling Sequence @@ -21,5 +21,3 @@ Calling Sequence .. autofunction:: gravity_toolkit.ocean_stokes .. autofunction:: gravity_toolkit.ocean_stokes.find_isolated_points - -.. [Sutterley2020] T. C. Sutterley, I. Velicogna, and C.-W. Hsu, "Self-Consistent Ice Mass Balance and Regional Sea Level From Time-Variable Gravity", *Earth and Space Science*, 7(3), (2020). `doi: 10.1029/2019EA000860 `_ diff --git a/doc/source/api_reference/run_sea_level_equation.rst b/doc/source/api_reference/run_sea_level_equation.rst index ee456d99..77a77c43 100644 --- a/doc/source/api_reference/run_sea_level_equation.rst +++ b/doc/source/api_reference/run_sea_level_equation.rst @@ -2,8 +2,8 @@ run_sea_level_equation.py ========================= -- Solves the sea level equation with the option of including polar motion feedback [Farrell1976]_ [Kendall2005]_ [Mitrovica2003]_ -- Uses a Clenshaw summation to calculate the spherical harmonic summation [Holmes2002]_ [Tscherning1982]_ +- Solves the sea level equation with the option of including polar motion feedback :cite:p:`Farrell:1976hm` :cite:p:`Kendall:2005ds` :cite:p:`Mitrovica:2003cq` +- Uses a Clenshaw summation to calculate the spherical harmonic summation :cite:p:`Holmes:2002ff` :cite:p:`Tscherning:1982tu` `Source code`__ @@ -21,59 +21,26 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --body -b : @after - * ``0``: [Wahr1981]_ and [Wahr1985]_ values from PREM - * ``1``: [Farrell1972]_ values from Gutenberg-Bullen oceanic mantle model + * ``0``: :cite:p:`Wahr:1981ea` and :cite:p:`Wahr:1985gr` values from PREM + * ``1``: :cite:p:`Farrell:1972cm` values from Gutenberg-Bullen oceanic mantle model --fluid -f : @after - * ``0``: [Han1989]_ fluid love number - * ``1``: [Munk1960]_ secular love number - * ``2``: [Munk1960]_ fluid love number - * ``3``: [Lambeck1980]_ fluid love number + * ``0``: :cite:p:`Han:1989kj` fluid love number + * ``1``: :cite:p:`Munk:1960uk` secular love number + * ``2``: :cite:p:`Munk:1960uk` fluid love number + * ``3``: :cite:p:`Lambeck:1980um` fluid love number --polar-feedback : @replace - Include polar feedback [Wahr1985]_ + Include polar feedback :cite:p:`Wahr:1985gr` --reference : @after * ``'CF'``: Center of Surface Figure * ``'CM'``: Center of Mass of Earth System * ``'CE'``: Center of Mass of Solid Earth - -References -########## - -.. [Blewett2003] G. Blewitt, "Self-consistency in reference frames, geocenter definition, and surface loading of the solid Earth", *Journal of Geophysical Research: Solid Earth*, 108(B2), 2103, (2003). `doi: 10.1029/2002JB002082 `_ - -.. [Farrell1972] W. E. Farrell, "Deformation of the Earth by surface loads", *Reviews of Geophysics*, 10(3), 761--797, (1972). `doi: 10.1029/RG010i003p00761 `_ - -.. [Farrell1976] W. E. Farrell and J. A. Clark, "On Postglacial Sea Level", *Geophysical Journal of the Royal Astronomical Society*, 46(3), 647--667, (1976). `doi: 10.1111/j.1365-246X.1976.tb01252.x `_ - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1989] D. Han and J. Wahr, "Post-Glacial Rebound Analysis for a Rotating Earth", *Slow Deformation and Transmission of Stress in the Earth*, 49, (1989). `doi: 10.1029/GM049p0001 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Holmes2002] S. A. Holmes and W. E. Featherstone, "A unified approach to the Clenshaw summation and the recursive computation of very high degree and order normalised associated Legendre functions", *Journal of Geodesy*, 76, 279--299, (2002). `doi: 10.1007/s00190-002-0216-2 `_ - -.. [Kendall2005] R. A. Kendall, J. X. Mitrovica, and G. A. Milne, "On post-glacial sea level -- II. Numerical formulation and comparative results on spherically symmetric models", *Geophysical Journal International*, 161(3), 679--706, (2005). `doi: 10.1111/j.1365-246X.2005.02553.x `_ - -.. [Lambeck1980] K. Lambeck, *The Earth's Variable Rotation: Geophysical Causes and Consequences*, First Edition, (1980). - -.. [Mitrovica2003] J. X. Mitrovica and G. A. Milne, "On post-glacial sea level: I. General theory", *Geophysical Journal International*, 154(2), 253--267, (2003). `doi: 10.1046/j.1365-246X.2003.01942.x `_ - -.. [Munk1960] W. H. Munk and G. J. F. MacDonald, *The Rotation of the Earth: A Geophysical Discussion*, First Edition, (1960). - -.. [Tscherning1982] C. C. Tscherning and K. Poder, "Some Geodetic Applications of Clenshaw Summation", *Bollettino di Geodesia e Scienze*, 4, 349--375, (1982). - -.. [Wahr1981] J. M. Wahr, "Body tides on an elliptical, rotating, elastic and oceanless Earth", *Geophysical Journal of the Royal Astronomical Society*, 64(3), 677--703, (1981). `doi: 10.1111/j.1365-246X.1981.tb02690.x `_ - -.. [Wahr1985] J. M. Wahr, "Deformation induced by polar motion", *Journal of Geophysical Research: Solid Earth*, 90(B11), 9363--9368, (1985). `doi: 10.1029/JB090iB11p09363 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ diff --git a/doc/source/api_reference/scale_grace_maps.rst b/doc/source/api_reference/scale_grace_maps.rst index 22da42b1..6594c87f 100644 --- a/doc/source/api_reference/scale_grace_maps.rst +++ b/doc/source/api_reference/scale_grace_maps.rst @@ -4,10 +4,10 @@ scale_grace_maps.py - Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports scaled spatial fields - Correct spherical harmonics with the specified GIA model group -- Filters and smooths data with specified processing algorithms [Jekeli1981]_ [Swenson2006]_ -- Converts data to centimeters water equivalent, performs a spherical harmonic summation to convert to the spatial domain [Wahr1998]_ -- Scales the spatial fields following [Landerer2012]_ -- Calculates the scaled spatial error field following [Wahr2006]_ +- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu` +- Converts data to centimeters water equivalent, performs a spherical harmonic summation to convert to the spatial domain :cite:p:`Wahr:1998hy` +- Scales the spatial fields following :cite:p:`Landerer:2012kf` +- Calculates the scaled spatial error field following :cite:p:`Wahr:2006bx` `Source code`__ @@ -24,11 +24,11 @@ Calling Sequence :nodefault: --love -n : @after - * ``0``: Han and Wahr (1995) values from PREM [Han1995]_ - * ``1``: Gegout (2005) values from PREM [Gegout2010]_ - * ``2``: Wang et al. (2012) values from PREM [Wang2012]_ - * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_ - * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_ + * ``0``: Han and Wahr (1995) values from PREM :cite:p:`Han:1995go` + * ``1``: Gegout (2005) values from PREM :cite:p:`Gegout:2010gc` + * ``2``: Wang et al. (2012) values from PREM :cite:p:`Wang:2012gc` + * ``3``: Wang et al. (2012) values from PREM with hard sediment :cite:p:`Wang:2012gc` + * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc` --reference : @after * ``'CF'``: Center of Surface Figure @@ -36,15 +36,15 @@ Calling Sequence * ``'CE'``: Center of Mass of Solid Earth --gia -G : @after - * ``'IJ05-R2'``: `Ivins R2 GIA Models `_ - * ``'W12a'``: `Whitehouse GIA Models `_ - * ``'SM09'``: `Simpson/Milne GIA Models `_ - * ``'ICE6G'``: `ICE-6G GIA Models `_ - * ``'Wu10'``: `Wu (2010) GIA Correction `_ - * ``'AW13-ICE6G'``: `Geruo A ICE-6G GIA Models `_ - * ``'AW13-IJ05'``: `Geruo A IJ05-R2 GIA Models `_ - * ``'Caron'``: `Caron JPL GIA Assimilation `_ - * ``'ICE6G-D'``: `ICE-6G Version-D GIA Models `_ + * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq` + * ``'W12a'``: Whitehouse GIA Models :cite:p:`Whitehouse:2012jj` + * ``'SM09'``: Simpson/Milne GIA Models :cite:p:`Simpson:2009hg` + * ``'ICE6G'``: ICE-6G GIA Models :cite:p:`Peltier:2015bo` + * ``'Wu10'``: Wu (2010) GIA Correction :cite:p:`Wu:2010dq` + * ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models :cite:p:`A:2013kh` + * ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models :cite:p:`A:2013kh` + * ``'Caron'``: Caron JPL GIA Assimilation :cite:p:`Caron:2018ba` + * ``'ICE6G-D'``: ICE-6G Version-D GIA Models :cite:p:`Peltier:2018dp` * ``'ascii'``: reformatted GIA in ascii format * ``'netCDF4'``: reformatted GIA in netCDF4 format * ``'HDF5'``: reformatted GIA in HDF5 format @@ -112,23 +112,4 @@ Calling Sequence * ``2``: (degree spacing/2) * ``3``: non-global grid (set with defined bounds) -References -########## - -.. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, "Practical numerical computation of love numbers and applications", Workshop of the COST Action ES0701, (2010). `doi: 10.13140/RG.2.1.1866.7045 `_ - -.. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a realistically stratified earth, and a further analysis of postglacial rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - -.. [Jekeli1981] C. Jekeli, "Alternative Methods to Smooth the Earth's Gravity Field", NASA Grant No. NGR 36-008-161, OSURF Proj. No. 783210, 48 pp., (1981). - -.. [Landerer2012] F. W. Landerer and S. C. Swenson, "Accuracy of scaled GRACE terrestrial water storage estimates", *Water Resources Research*, 48(W04531), (2012). `doi: 10.1029/2011WR011453 `_ - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wahr2006] J. Wahr, S. Swenson, and I. Velicogna, "Accuracy of GRACE mass estimates", Geophysical Research Letters, 33(L06401), (2006). `doi: 10.1029/2005GL025305 `_ - -.. [Wang2012] H. Wang et al., "Load Love numbers and Green's functions for elastic Earth models PREM, iasp91, ak135, and modified models with refined crustal structure from Crust 2.0", *Computers & Geosciences*, 49, 190--199, (2012). `doi: 10.1016/j.cageo.2012.06.022 `_ - .. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN diff --git a/doc/source/api_reference/tools.rst b/doc/source/api_reference/tools.rst index d53c1b26..d3fdbf56 100644 --- a/doc/source/api_reference/tools.rst +++ b/doc/source/api_reference/tools.rst @@ -26,20 +26,3 @@ General Attributes and Methods .. autofunction:: gravity_toolkit.tools.interp_grid .. autofunction:: gravity_toolkit.tools.mask_oceans - - -References -########## - -.. [Fagiolini2015] E. Fagiolini, F. Flechtner, M. Horwath, and H. Dobslaw, "Correction of inconsistencies in ECMWF's operational analysis data during de-aliasing of GRACE gravity models", *Geophysical Journal International*, 202(3), 2150--2158, (2015). `doi: 10.1093/gji/ggv276 `_ - -.. [Joughin2018] I. Joughin, B. E. Smith, and I. Howat, "Greenland Ice Mapping Project: ice flow velocity variation at sub-monthly to decadal timescales", *The Cryosphere*, 12, 2211--2227, (2018). `doi: 10.5194/tc-12-2211-2018 `_ - -.. [Rignot2011] E. Rignot J. Mouginot, and B. Scheuchl, "Ice Flow of the Antarctic Ice Sheet", *Science*, 333(6048), 1427--1430, (2011). `doi: 10.1126/science.1208336 `_ - -.. [Seroussi2011] H. Seroussi, M. Morlighem, E. Rignot, E. Larour, D. Aubry, H. Ben Dhia, and S. S. Kristensen, "Ice flux divergence anomalies on 79north Glacier, Greenland", *Geophysical Research Letters*, 38(L09501), (2011). `doi: 10.1029/2011GL047338 `_ - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Wahr2015] J. Wahr, R. S. Nerem, and S. V. Bettadpur, "The pole tide and its effect on GRACE time-variable gravity measurements: Implications for estimates of surface mass variations". *Journal of Geophysical Research: Solid Earth*, 120(6), 4597--4615, (2015). `doi: 10.1002/2015JB011986 `_ - diff --git a/doc/source/api_reference/units.rst b/doc/source/api_reference/units.rst index ab75a3e0..851d5327 100644 --- a/doc/source/api_reference/units.rst +++ b/doc/source/api_reference/units.rst @@ -37,17 +37,3 @@ General Attributes and Methods .. autoclass:: gravity_toolkit.units :members: -References ----------- -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, - "Time variability of the Earth's gravity field: - Hydrological and oceanic effects and their possible - detection using GRACE", *Journal of Geophysical Research*, - 103(B12), 30205--30229, (1998). - `doi: 10.1029/98JB02844 `_ -.. [Wahr2000] J. Wahr, D. Wingham, and C. Bentley, - "A method of combining ICESat and GRACE satellite data - to constrain Antarctic mass balance", - *Journal of Geophysical Research: Solid Earth*, - 105(B7), 16279--16294, (2000). - `doi: 10.1029/2000JB900113 `_ diff --git a/doc/source/conf.py b/doc/source/conf.py index 9bbe8e2c..36271629 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -14,18 +14,22 @@ # import sys import datetime # sys.path.insert(0, os.path.abspath('.')) +import importlib.metadata # -- Project information ----------------------------------------------------- -project = 'gravity-toolkit' +# package metadata +metadata = importlib.metadata.metadata("gravity-toolkit") +project = metadata["Name"] year = datetime.date.today().year copyright = f"2019\u2013{year}, Tyler C. Sutterley" author = 'Tyler C. Sutterley' # The full version, including alpha/beta/rc tags -with open(os.path.abspath('../../version.txt')) as fh: - release = fh.read() +version = metadata["version"] +# append "v" before the version +release = f"v{version}" # -- General configuration --------------------------------------------------- @@ -33,8 +37,9 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - "sphinx.ext.autodoc", "numpydoc", + 'sphinxcontrib.bibtex', + "sphinx.ext.autodoc", "sphinx.ext.graphviz", "sphinx.ext.viewcode", "sphinxarg.ext" @@ -56,6 +61,8 @@ autodoc_member_order = 'bysource' numpydoc_show_class_members = False pygments_style = 'native' +bibtex_bibfiles = ['_assets/gravity-refs.bib'] +bibtex_default_style = 'plain' # -- Options for HTML output ------------------------------------------------- diff --git a/doc/source/getting_started/Background.rst b/doc/source/getting_started/Background.rst index 0d12f06d..49d6295c 100644 --- a/doc/source/getting_started/Background.rst +++ b/doc/source/getting_started/Background.rst @@ -83,7 +83,7 @@ use of `Jupyter Notebooks <../user_guide/Examples.html>`_. Measurement Principle ##################### -GRACE and the GRACE Follow-on (GRACE-FO) missions each consist of twin satellites in similar low Earth orbits [Tapley2019]_. +GRACE and the GRACE Follow-on (GRACE-FO) missions each consist of twin satellites in similar low Earth orbits :cite:p:`Tapley:2019cm`. The primary and secondary instrumentation onboard the GRACE/GRACE-FO satellites are the ranging instrument (GRACE has a microwave ranging instrument, GRACE-FO has both a microwave ranging instrument and a laser interferometer), the global positioning system (GPS), the accelerometers and the star cameras. @@ -124,20 +124,20 @@ Geoid Height The Level-2 spherical harmonic product of GRACE and GRACE-FO provides monthly estimates of the Earth's gravitational field. The Earth's gravitational field varies in time as masses on and within the -Earth move and are exchanged between components of the Earth system [Wahr1998]_. +Earth move and are exchanged between components of the Earth system :cite:p:`Wahr:1998hy`. The instantaneous shape of the Earth's gravitational field can be described in terms of an equipotential surface, a surface of constant potential energy -where the gravitational potential is constant [HofmannWellenhof2006]_. +where the gravitational potential is constant :cite:p:`HofmannWellenhof:2006hy`. The Earth's geoid is the equipotential surface that coincides with global mean -sea level if the oceans were at rest [HofmannWellenhof2006]_ [Wahr1998]_. +sea level if the oceans were at rest :cite:p:`HofmannWellenhof:2006hy` :cite:p:`Wahr:1998hy`. The distance between the geoid and an Earth reference ellipsoid is the -geoid height (:math:`N`), or the geoidal undulation [HofmannWellenhof2006]_. +geoid height (:math:`N`), or the geoidal undulation :cite:p:`HofmannWellenhof:2006hy`. .. figure:: ../_assets/geoid_height.svg :width: 400 :align: center - Relationship between ellipsoid height, geoid height, and topographic height [NRC2010]_ + Relationship between ellipsoid height, geoid height, and topographic height :cite:p:`NRC:1997ea` In spherical coordinates, the change in the height of the geoid, :math:`\Delta N(\theta,\phi)`, at colatitude :math:`\theta` and longitude :math:`\phi`, @@ -150,15 +150,15 @@ can be estimated from a series of spherical harmonics as: where :math:`a` is the average radius of the Earth, :math:`P_{lm}(\cos\theta)` are the fully-normalized Legendre polynomials of degree :math:`l` and order :math:`m` for the cosine of colatitude :math:`\theta`, and -:math:`\Delta C_{lm}`, :math:`\Delta S_{lm}` are the changes in the cosine and sine spherical harmonics of degree :math:`l` and order :math:`m` [Chao1987]_. +:math:`\Delta C_{lm}`, :math:`\Delta S_{lm}` are the changes in the cosine and sine spherical harmonics of degree :math:`l` and order :math:`m` :cite:p:`Chao:1987fq`. Surface Mass Density #################### The radial component of a density change within the Earth cannot be uniquely -determined using satellite gravity observations alone [Wahr1998]_. +determined using satellite gravity observations alone :cite:p:`Wahr:1998hy`. However, fluctuations in water storage and transport can be assumed to be largely -concentrated within a thin layer near the Earth's surface [Wahr1998]_. +concentrated within a thin layer near the Earth's surface :cite:p:`Wahr:1998hy`. With this assumption, the Earth's surface mass density (:math:`\Delta\sigma(\theta,\phi)`), the integral of the density change (:math:`\Delta\rho(r,\theta,\phi)`) through the thin surface layer, @@ -175,17 +175,4 @@ Using this assumption, solid Earth variations occurring outside of this thin layer, such as Glacial Isostatic Adjustment (GIA) effects, must be independently estimated and removed. -References -########## - -.. [Chao1987] B. F. Chao and R. S. Gross, "Changes in the Earth's rotation and low-degree gravitational field induced by earthquakes", *Geophysical Journal International*, 91(3), 569--596 (1987). `doi: 10.1111/j.1365-246X.1987.tb01659.x `_ - -.. [HofmannWellenhof2006] B. Hofmann-Wellenhof and H. Moritz, *Physical Geodesy*, 2nd Edition, 403 pp., (2006). `doi: 10.1007/978-3-211-33545-1 `_ - -.. [NRC2010] National Research Council. *Satellite Gravity and the Geosphere: Contributions to the Study of the Solid Earth and Its Fluid Envelopes*. The National Academies Press, Washington, DC, 1997. ISBN 978-0-309-05792-9. `doi: 10.17226/5767 `_ - -.. [Tapley2019] B. D. Tapley, M. M. Watkins, F. Flechtner et al. "Contributions of GRACE to understanding climate change", *Nature Climate Change*, 9, 358--369 (2019). `doi: 10.1038/s41558-019-0456-2 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - .. |rarr| unicode:: U+2192 .. RIGHTWARDS ARROW diff --git a/doc/source/getting_started/Bibliography.rst b/doc/source/getting_started/Bibliography.rst new file mode 100644 index 00000000..73b0782c --- /dev/null +++ b/doc/source/getting_started/Bibliography.rst @@ -0,0 +1,5 @@ +============ +Bibliography +============ + +.. bibliography:: diff --git a/doc/source/getting_started/Geocenter-Variations.rst b/doc/source/getting_started/Geocenter-Variations.rst index fe1fcc05..3065da66 100644 --- a/doc/source/getting_started/Geocenter-Variations.rst +++ b/doc/source/getting_started/Geocenter-Variations.rst @@ -16,15 +16,15 @@ system with an origin coinciding with the Earth's center of figure Geocenter variations are represented by the degree one spherical harmonic terms. The exclusion of degree one terms can have a significant impact on estimates of ocean mass, ice sheet mass change, and terrestrial hydrology due to -far-field signals leaking into each regional estimate [Velicogna2009]_. +far-field signals leaking into each regional estimate :cite:p:`Velicogna:2009ft`. ``calc_degree_one.py`` calculates coefficients of degree one by combining GRACE/GRACE-FO spherical harmonic products with estimates of -ocean bottom pressure (OBP) following [Swenson2008]_ and [Sutterley2019]_. +ocean bottom pressure (OBP) following :cite:p:`Swenson:2008cr` and :cite:p:`Sutterley:2019bx`. The method assumes that the change in global surface mass density, :math:`\Delta\sigma(\theta,\phi)`, can be separated into individual land and ocean components using a land-function -:math:`\vartheta(\theta,\phi)` [Swenson2008]_. +:math:`\vartheta(\theta,\phi)` :cite:p:`Swenson:2008cr`. .. math:: :label: 4 @@ -35,17 +35,17 @@ land and ocean components using a land-function The oceanic components of the change in degree one spherical harmonics (:math:`\Delta C^{ocean}_{10}`, :math:`\Delta C^{ocean}_{11}`, and :math:`\Delta S^{ocean}_{11}`) can then be calculated from the changes in ocean mass, -:math:`\Delta\sigma_{ocean}(\theta,\phi)` [Swenson2008]_ [Wahr1998]_. +:math:`\Delta\sigma_{ocean}(\theta,\phi)` :cite:p:`Swenson:2008cr` :cite:p:`Wahr:1998hy`. If the oceanic contributions to degree one variability (:math:`\Delta C^{ocean}_{10}`, :math:`\Delta C^{ocean}_{11}`, and :math:`\Delta S^{ocean}_{11}`) can be estimated from an ocean model, then the unknown complete degree one terms (:math:`\Delta C_{10}`, :math:`\Delta C_{11}`, and :math:`\Delta S_{11}`) can be calculated from the residual between the oceanic degree one terms and the measured mass change over the ocean calculated using all other degrees of -the global spherical harmonics from GRACE/GRACE-FO [Swenson2008]_ [Sutterley2019]_. +the global spherical harmonics from GRACE/GRACE-FO :cite:p:`Swenson:2008cr` :cite:p:`Sutterley:2019bx`. The ``calc_degree_one.py`` program will output geocenter files in ascii format -for each GRACE/GRACE-FO month following [Sutterley2019]_. +for each GRACE/GRACE-FO month following :cite:p:`Sutterley:2019bx`. Uncertainties in geocenter due to a combination of error sources can be estimated using the ``monte_carlo_degree_one.py`` program. @@ -55,7 +55,7 @@ Load Love Numbers The degree one Love number of gravitational potential :math:`k_1` is defined so that the degree one terms describe the offset between the center of mass (CM) of the combined surface mass and deformed solid Earth, and the center of figure (CF) -of the deformed solid Earth surface [Trupin1992]_ [Blewett2003]_. +of the deformed solid Earth surface :cite:p:`Trupin:1992kp` :cite:p:`Blewitt:2003bz`. For the CF coordinate system, this means .. math:: @@ -83,26 +83,3 @@ cartesian geocenter variations using the following relation: The ``geocenter`` class has utilities for converting between spherical harmonics and geocenter variation along with readers for different geocenter datasets. - -References -########## - -.. [Blewett2003] G. Blewitt, "Self-consistency in reference frames, geocenter definition, and surface loading of the solid Earth", *Journal of Geophysical Research: Solid Earth*, 108(B2), 2103, (2003). `doi: 10.1029/2002JB002082 `_ - -.. [Cheng2013] M. Cheng, "Geocenter Variations from Analysis of SLR Data", *Reference Frames for Applications in Geosciences*, 19--25, (2013). `doi: 10.1007/978-3-642-32998-2_4 `_ - -.. [Dziewonski1981] A. M. Dziewonski and D. L. Anderson, "Preliminary reference Earth model", *Physics of the Earth and Planetary Interiors*, 25(4), 297--356, (1981). `doi: 10.1016/0031-9201(81)90046-7 `_ - -.. [Farrell1972] W. E. Farrell, "Deformation of the Earth by surface loads", *Reviews of Geophysics*, 10(3), 761--797, (1972). `doi: 10.1029/RG010i003p00761 `_ - -.. [Sutterley2019] T. C. Sutterley and I. Velicogna, "Improved Estimates of Geocenter Variability from Time-Variable Gravity and Ocean Model Outputs", *Remote Sensing*, 11(18), 2108, (2019). `doi: 10.3390/rs11182108 `_ - -.. [Swenson2008] S. Swenson, D. Chambers, and J. Wahr, "Estimating geocenter variations from a combination of GRACE and ocean model output", *Journal of Geophysical Research: Solid Earth*, 113(B08410), (2008). `doi: 10.1029/2007JB005338 `_ - -.. [Trupin1992] A. S. Trupin, M. F. Meier, and J. Wahr, "Effect of melting glaciers on the Earth's rotation and gravitational field: 1965--1984", *Geophysical Journal International*, 108(1), (1992). `doi: 10.1111/j.1365-246X.1992.tb00835.x `_ - -.. [Velicogna2009] I. Velicogna, "Increasing rates of ice mass loss from the Greenland and Antarctic ice sheets revealed by GRACE", *Geophysical Research Letters*, 36(L19503), (2009). `doi: 10.1029/2009GL040222 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wahr2006] J. Wahr, S. Swenson, and I. Velicogna, "Accuracy of GRACE mass estimates", Geophysical Research Letters, 33(L06401), (2006). `doi: 10.1029/2005GL025305 `_ diff --git a/doc/source/getting_started/Spatial-Maps.rst b/doc/source/getting_started/Spatial-Maps.rst index 4c3b397c..10f4043d 100644 --- a/doc/source/getting_started/Spatial-Maps.rst +++ b/doc/source/getting_started/Spatial-Maps.rst @@ -4,7 +4,7 @@ Spatial Maps The GRACE/GRACE-FO spherical harmonic products can be converted into sets of spatial maps if we assume that the mass redistributions are concentrated within a thin layer -(thickness |mlt| horizontal resolution) [Wahr1998]_. +(thickness |mlt| horizontal resolution) :cite:p:`Wahr:1998hy`. To calculate accurate maps of spatial variability, several processing steps need to be accounted for to convert the data into the proper reference frame, reduce the impact of noisy data, remove unwanted sources of gravitational variability, and convert to appropriate units. @@ -16,16 +16,16 @@ Load Love Numbers ################# A variation in mass at the Earth's surface will load and deform the solid Earth, -which will induce density anomalies at depth [Wahr1998]_. +which will induce density anomalies at depth :cite:p:`Wahr:1998hy`. To accurately assess the surface load from time-variable gravity, -we need to compensate for the Earth's elastic yielding [Wahr1998]_. +we need to compensate for the Earth's elastic yielding :cite:p:`Wahr:1998hy`. The elastic deformation of the solid Earth induced by a change in surface load can be estimated using load Love numbers. Using load Love numbers to calculate the elastic yielding assumes that all other time-variable solid Earth contributions have been independently -removed from the spherical harmonic coefficients [Wahr1998]_. +removed from the spherical harmonic coefficients :cite:p:`Wahr:1998hy`. Here, we use load Love and Shida numbers with parameters calculated from -the Preliminary Reference Earth model (PREM) [Farrell1972]_ [Dziewonski1981]_. +the Preliminary Reference Earth model (PREM) :cite:p:`Farrell:1972cm` :cite:p:`Dziewonski:1981bz`. In order to help estimate the uncertainty in elastic deformation, ``grace_spatial_maps.py`` can use different sets of load Love numbers by adjusting the ``--love`` command line option. @@ -37,17 +37,17 @@ Measurements of time-variable gravity from the Gravity Recovery and Climate Expe and the GRACE Follow-On (GRACE-FO) missions are set in a center of mass (CM) reference frame, in which the total degree one variations are inherently zero. The individual contributions to degree one variations in the CM reference frame, -such as from oceanic processes or terrestrial water storage change, are not necessarily zero [Wahr1998]_. +such as from oceanic processes or terrestrial water storage change, are not necessarily zero :cite:p:`Wahr:1998hy`. Applications set in a center of figure (CF) reference frame, such as the recovery of mass variations of the oceans, hydrosphere and cryosphere, -require the inclusion of degree one terms to be fully accurate [Swenson2008]_. +require the inclusion of degree one terms to be fully accurate :cite:p:`Swenson:2008cr`. ``grace_spatial_maps.py`` has geocenter options to select the degree one product to include with the GRACE/GRACE-FO derived harmonics. -There are options for using measurements from satellite laser ranging [Cheng2013]_ and -calculations from time-variable gravity and ocean model outputs [Swenson2008]_ [Sutterley2019]_. +There are options for using measurements from satellite laser ranging :cite:p:`Cheng:2013tz` and +calculations from time-variable gravity and ocean model outputs :cite:p:`Swenson:2008cr` :cite:p:`Sutterley:2019bx`. If including degree one harmonics and changing the reference frame, -the reference frame for the load Love numbers needs to be updated accordingly [Blewett2003]_. +the reference frame for the load Love numbers needs to be updated accordingly :cite:p:`Blewitt:2003bz`. In ``grace_spatial_maps.py`` and other GRACE/GRACE-FO programs, the reference frame for the load Love numbers is adjusted by setting the ``--reference`` command line option to ``'CF'``. @@ -68,14 +68,14 @@ malfunction and the accelerometer onboard GRACE-FO 2 (GF2) has been operating in less optimal Large-Range-Mode. For both of these cases, the GRACE/GRACE-FO processing centers have developed independent methods to spatiotemporally transplant the accelerometer data retrieved -from GRACE-A to GRACE-B and from GF1 to GF2 [Bandikova2019]_. +from GRACE-A to GRACE-B and from GF1 to GF2 :cite:p:`Bandikova:2019ji`. These single-accelerometer months for both GRACE and GRACE-FO contain significantly more noise, particularly the low-degree zonal harmonics (predominantly :math:`C_{20}` and :math:`C_{30}` but possibly :math:`C_{40}` and :math:`C_{50}`). :math:`C_{20}` has also been difficult for GRACE and GRACE-FO to independently measure throughout both missions. The figure axis harmonics (:math:`C_{21}` and :math:`S_{21}`) may also be contaminated -by noise during the single-accelerometer months in the GFZ products [Dahle2019]_. +by noise during the single-accelerometer months in the GFZ products :cite:p:`Dahle:2019jf`. Measurements from satellite laser ranging (SLR) can provide an independent assessment for some low degree and order spherical harmonics. ``grace_spatial_maps.py`` has options for replacing @@ -87,16 +87,16 @@ for some low degree and order spherical harmonics. :math:`C_{30}`, :math:`C_{40}`, and :math:`C_{50}` with -SLR low degree harmonic products [Cheng2011]_ [Cheng2018]_ [Koenig2019]_ [Loomis2019]_ [Loomis2020]_. +SLR low degree harmonic products :cite:p:`Cheng:2011hh` :cite:p:`Cheng:2018jz` :cite:p:`Koenig:2019gs` :cite:p:`Loomis:2019dc` :cite:p:`Loomis:2020bq`. Corrections ########### Prior to GRACE/GRACE-FO Release-6, corrections needed to be applied to compensate for long-period signals in the pole tide that were contaminating the -:math:`C_{21}` and :math:`S_{21}` harmonics [Wahr2015]_, +:math:`C_{21}` and :math:`S_{21}` harmonics :cite:p:`Wahr:2015dg`, as well as for discontinuities in the atmospheric de-aliasing product that were -introduced with upgrades in the ECMWF weather prediction model [Fagiolini2015]_. +introduced with upgrades in the ECMWF weather prediction model :cite:p:`Fagiolini:2015kc`. The Pole Tide and Atmospheric corrections do not need to be applied to the Release-6 data. Geophysical Leakage @@ -106,7 +106,7 @@ Gravity measurements from GRACE and GRACE-FO are global, near-monthly and are directly related to changes in mass. Several mass transport processes can occur concurrently for a given region, which means that the total time-dependent geopotential from GRACE/GRACE-FO -can relate to multiple time-varying components [Wahr1998]_. +can relate to multiple time-varying components :cite:p:`Wahr:1998hy`. These mass transport processes include but are not limited to terrestrial water storage, glacier and ice sheet mass, atmospheric and oceanic circulation and geodynamic processes. In order to isolate the mass change of a single process, each of the other processes @@ -118,55 +118,16 @@ Filtering ######### The GRACE/GRACE-FO coefficients are impacted by random spherical harmonic errors -that increase as a function of spherical harmonic degree [Wahr1998]_ [Swenson2002]_. +that increase as a function of spherical harmonic degree :cite:p:`Wahr:1998hy` :cite:p:`Swenson:2002hs`. The truncation of the spherical harmonics series also results in spurious ringing artifacts from Gibbs phenomenon. The impact of these errors can be reduced using Gaussian averaging functions -as described in [Jekeli1981]_ [Swenson2002]_. +as described in :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2002hs`. GRACE/GRACE-FO coefficients are also impacted by correlated north/south "striping" errors, -which can be spectrally filtered following [Swenson2006]_. - -References -########## - -.. [Bandikova2019] T. Bandikova, C. McCullough, G. L. Kruizinga, H. Save, and B. Christophe, "GRACE accelerometer data transplant", *Advances in Space Research*, 64(3), 623--644, (2019). `doi: 10.1016/j.asr.2019.05.021 `_ - -.. [Blewett2003] G. Blewitt, "Self-consistency in reference frames, geocenter definition, and surface loading of the solid Earth", *Journal of Geophysical Research: Solid Earth*, 108(B2), 2103, (2003). `doi: 10.1029/2002JB002082 `_ - -.. [Cheng2011] M. Cheng, J. C. Ries, and B. D. Tapley, "Variations of the Earth's figure axis from satellite laser ranging and GRACE", *Journal of Geophysical Research: Solid Earth*, 116, B01409, (2011). `doi: 10.1029/2010JB000850 `_ - -.. [Cheng2013] M. Cheng, "Geocenter Variations from Analysis of SLR Data", *Reference Frames for Applications in Geosciences*, 19--25, (2013). `doi: 10.1007/978-3-642-32998-2_4 `_ - -.. [Cheng2018] M. Cheng and J. C. Ries, "Decadal variation in Earth's oblateness (J2) from satellite laser ranging data", *Geophysical Journal International*, 212(2), 1218--1224 (2018). `doi: 10.1093/gji/ggx483 `_ - -.. [Dahle2019] C. Dahle et al. "The GFZ GRACE RL06 Monthly Gravity Field Time Series: Processing Details, and Quality Assessment", *Remote Sensing*, 11(18), 2116, (2019). `doi: 10.3390/rs11182116 `_ - -.. [Dziewonski1981] A. M. Dziewonski and D. L. Anderson, "Preliminary reference Earth model", *Physics of the Earth and Planetary Interiors*, 25(4), 297--356, (1981). `doi: 10.1016/0031-9201(81)90046-7 `_ - -.. [Fagiolini2015] E. Fagiolini, F. Flechtner, M. Horwath, and H. Dobslaw, "Correction of inconsistencies in ECMWF's operational analysis data during de-aliasing of GRACE gravity models", *Geophysical Journal International*, 202(3), 2150--2158, (2015). `doi: 10.1093/gji/ggv276 `_ - -.. [Farrell1972] W. E. Farrell, "Deformation of the Earth by surface loads", *Reviews of Geophysics*, 10(3), 761--797, (1972). `doi: 10.1029/RG010i003p00761 `_ - -.. [Jekeli1981] C. Jekeli, "Alternative Methods to Smooth the Earth's Gravity Field", NASA Grant No. NGR 36-008-161, OSURF Proj. No. 783210, 48 pp., (1981). - -.. [Koenig2019] R. Koenig, P. Schreiner, and C. Dahle, "Monthly estimates of C(2,0) generated by GFZ from SLR satellites based on GFZ GRACE/GRACE-FO RL06 background models", V. 1.0. GFZ Data Services, (2019). `doi: 10.5880/GFZ.GRAVIS_06_C20_SLR `_ - -.. [Loomis2019] B. D. Loomis, K. E. Rachlin, and S. B. Luthcke, "Improved Earth oblateness rate reveals increased ice sheet losses and mass-driven sea level rise". *Geophysical Research Letters*, 46, 6910--6917, (2019). `doi: 10.1029/2019GL082929 `_ - -.. [Loomis2020] B. D. Loomis, K. E. Rachlin, D. N. Wiese, F. W. Landerer, and S. B. Luthcke, "Replacing GRACE/GRACE-FO *C*\ :sub:`30` with satellite laser ranging: Impacts on Antarctic Ice Sheet mass change". *Geophysical Research Letters*, 47, (2020). `doi: 10.1029/2019GL085488 `_ - -.. [Sutterley2019] T. C. Sutterley and I. Velicogna, "Improved Estimates of Geocenter Variability from Time-Variable Gravity and Ocean Model Outputs", *Remote Sensing*, 11(18), 2108, (2019). `doi: 10.3390/rs11182108 `_ - -.. [Swenson2002] S. Swenson and J. Wahr, "Methods for inferring regional surface-mass anomalies from Gravity Recovery and Climate Experiment (GRACE) measurements of time-variable gravity", *Journal of Geophysical Research: Solid Earth*, 107(B9), 2193, (2002). `doi: 10.1029/2001JB000576 `_ - -.. [Swenson2006] S. Swenson and J. Wahr, "Post-processing removal of correlated errors in GRACE data", *Geophysical Research Letters*, 33(L08402), (2006). `doi: 10.1029/2005GL025285 `_ - -.. [Swenson2008] S. Swenson, D. Chambers, and J. Wahr, "Estimating geocenter variations from a combination of GRACE and ocean model output", *Journal of Geophysical Research: Solid Earth*, 113(B08410), (2008). `doi: 10.1029/2007JB005338 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wahr2015] J. Wahr, R. S. Nerem, and S. V. Bettadpur, "The pole tide and its effect on GRACE time-variable gravity measurements: Implications for estimates of surface mass variations". *Journal of Geophysical Research: Solid Earth*, 120(6), 4597--4615, (2015). `doi: 10.1002/2015JB011986 `_ +which can be spectrally filtered following :cite:p:`Swenson:2006hu`. .. |beta| unicode:: U+03B2 .. GREEK SMALL LETTER BETA + .. |mu| unicode:: U+03BC .. GREEK SMALL LETTER MU + .. |mlt| unicode:: U+226A .. MUCH LESS-THAN \ No newline at end of file diff --git a/doc/source/getting_started/Time-Series-Analysis.rst b/doc/source/getting_started/Time-Series-Analysis.rst index cdf671fb..d605e9a1 100644 --- a/doc/source/getting_started/Time-Series-Analysis.rst +++ b/doc/source/getting_started/Time-Series-Analysis.rst @@ -5,14 +5,14 @@ Time Series Analysis Least-squares mascons are a method of extracting a regional signal from the GRACE/GRACE-FO spherical harmonic data. The procedure was outlined in procedure outlined in -[Tiwari2009]_ and [Jacob2012]_. +:cite:p:`Tiwari:2009bx` and :cite:p:`Jacob:2012gv`. Least-squares mascons can be considered a post-processing technique for analyzing the GRACE/GRACE-FO data. The technique calculates the scaling factor between an input kernel and the GRACE/GRACE-FO data for a given month. In an ideal case, the input kernel is a spatially discrete, uniformly distributed layer of equivalent water height at colatitudes -:math:`\theta` and longitudes :math:`\phi` [Rowlands2010]_. +:math:`\theta` and longitudes :math:`\phi` :cite:p:`Rowlands:2010hj`. .. math:: :label: 3 @@ -29,21 +29,21 @@ For example, for a uniform kernel equivalent to 1 cm w.e., if GRACE/GRACE-FO measures 6 cm w.e. in the region, then the scaling factor would be 6. However, the GRACE/GRACE-FO harmonic solutions are truncated and typically smoothed, meaning that the sharp 0-to-1 transitions along regional boundaries cannot be -resolved at the inherent GRACE/GRACE-FO resolution [Wahr1998]_. +resolved at the inherent GRACE/GRACE-FO resolution :cite:p:`Wahr:1998hy`. The mascon kernels are instead represented as sets of truncated spherical -harmonics processed in the same manner as the GRACE/GRACE-FO data [Jacob2012]_. +harmonics processed in the same manner as the GRACE/GRACE-FO data :cite:p:`Jacob:2012gv`. In this case, each mascon kernel is a smoothed function with a total mass equal to the idealized case. Ideally, the final solution for the recovered mascon mass, is equal -to the true spatial average across the mascon [Jacob2012]_. +to the true spatial average across the mascon :cite:p:`Jacob:2012gv`. Misfits in the regression or malformed initial kernels can lead to the leakage of GRACE/GRACE-FO signal in-between mascons or out of the system. The least squares mascon technique assumes that the GRACE/GRACE-FO signal are well represented as scalar multiples of the mascons at any given time. As the initial mascon parameters are designed with uniform mass distributions, the GRACE/GRACE-FO anomalies over each mascon must also be uniform to limit -statistical misfit [Jacob2012]_. +statistical misfit :cite:p:`Jacob:2012gv`. Hypothetically, we would want as small of kernels as possible to get as geophysically relevant as possible (perfect fit to region shape). @@ -56,27 +56,12 @@ Thus there is a balance between wanting kernels as geophysically relevant as possible with wanting idealistic kernels which minimize ringing and are resolvable. Getting the kernels "just right" in order to isolate regions of interest takes some time. -The set of least-squares mascon programs have been used in [Velicogna2014]_ +The set of least-squares mascon programs have been used in :cite:p:`Velicogna:2014km` and other publications for regional time series analysis. The ``calc_mascon.py`` program additionally calculates the GRACE/GRACE-FO error -harmonics following [Wahr2006]_. +harmonics following :cite:p:`Wahr:2006bx`. The ``calc_mascon.py`` program will output a text file of the time series for each mascon (format: GRACE/GRACE-FO month, mid-month date in decimal-year format, estimated monthly mass anomaly [Gt], estimated monthly error [Gt], mascon area [km\ :sup:`2`]). - -References -########## - -.. [Jacob2012] T. Jacob, J. Wahr, W. T. Pfeffer, and S. Swenson, "Recent contributions of glaciers and ice caps to sea level rise", *Nature*, 482, 514--518, (2012). `doi: 10.1038/nature10847 `_ - -.. [Rowlands2010] D. D. Rowlands, S. B. Luthcke, J. J. McCarthy, S. M. Klosko, D. S. Chinn, F. G. R. Lemoine, J. P. Boy, and T. J. Sabaka, "Global mass flux solutions from GRACE: A comparison of parameter estimation strategies---Mass concentrations versus Stokes coefficients", *Journal of Geophysical Research: Solid Earth*, 115(B01403), (2010). `doi: 10.1029/2009JB006546 `_ - -.. [Tiwari2009] V. M. Tiwari, J. Wahr, and S. Swenson, "Dwindling groundwater resources in northern India, from satellite gravity observations", *Geophysical Research Letters*, 36(L18401), (2009). `doi: 10.1029/2009GL039401 `_ - -.. [Velicogna2014] I. Velicogna, T. C. Sutterley, and M. R. van den Broeke, "Regional acceleration in ice mass loss from Greenland and Antarctica using GRACE time-variable gravity data", *Geophysical Research Letters*, 119, 8130--8137, (2014). `doi: 10.1002/2014GL061052 `_ - -.. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time variability of the Earth's gravity field: Hydrological and oceanic effects and their possible detection using GRACE", *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). `doi: 10.1029/98JB02844 `_ - -.. [Wahr2006] J. Wahr, S. Swenson, and I. Velicogna, "Accuracy of GRACE mass estimates", Geophysical Research Letters, 33(L06401), (2006). `doi: 10.1029/2005GL025305 `_ diff --git a/doc/source/index.rst b/doc/source/index.rst index d60e5b78..ffc38f8e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -148,3 +148,10 @@ missions api_reference/plot_GrIS_grid_5maps.rst api_reference/plot_GrIS_grid_movie.rst api_reference/quick_mascon_plot.rst + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: Bibliography + + getting_started/Bibliography.rst diff --git a/gravity_toolkit/associated_legendre.py b/gravity_toolkit/associated_legendre.py index 308dd69a..33ae2898 100644 --- a/gravity_toolkit/associated_legendre.py +++ b/gravity_toolkit/associated_legendre.py @@ -71,7 +71,7 @@ def plm_colombo(LMAX, x, ): """ Computes fully-normalized associated Legendre Polynomials and their - first derivative using a Standard forward column method [Colombo1981]_ + first derivative using a Standard forward column method :cite:p:`Colombo:1981vh` Parameters ---------- @@ -92,24 +92,6 @@ def plm_colombo(LMAX, x, fully-normalized Legendre polynomials dplms: np.ndarray first derivative of Legendre polynomials - - References - ---------- - .. [Colombo1981] O. L. Colombo, - "Numerical Methods for Harmonic Analysis on the Sphere", - Air Force Contract No. F19628-79-C-0027, - *OSURF Proj. No. 711664*, 140 pp., (1981). - .. [Losch2003] M. Losch and V. Seufer, - "How to Compute Geoid Undulations (Geoid Height Relative - to a Given Reference Ellipsoid) from Spherical Harmonic - Coefficients for Satellite Altimetry Applications", (2003). - `eprint ID: 11802 `_ - .. [Holmes2002] S. A. Holmes and W. E. Featherstone, - "A unified approach to the Clenshaw summation and the - recursive computation of very high degree and order - normalised associated Legendre functions", - *Journal of Geodesy*, 76, 279--299, (2002). - `doi: 10.1007/s00190-002-0216-2 `_ """ # removing singleton dimensions of x @@ -168,7 +150,7 @@ def plm_holmes(LMAX, x, ): """ Computes fully-normalized associated Legendre Polynomials and their - first derivative using the recursion relation from [Holmes2002]_ + first derivative using the recursion relation from :cite:p:`Holmes:2002ff` Parameters ---------- @@ -189,20 +171,6 @@ def plm_holmes(LMAX, x, fully-normalized Legendre polynomials dplms: np.ndarray first derivative of Legendre polynomials - - References - ---------- - .. [Losch2003] M. Losch and V. Seufer, - "How to Compute Geoid Undulations (Geoid Height Relative - to a Given Reference Ellipsoid) from Spherical Harmonic - Coefficients for Satellite Altimetry Applications", (2003). - `eprint ID: 11802 `_ - .. [Holmes2002] S. A. Holmes and W. E. Featherstone, - "A unified approach to the Clenshaw summation and the - recursive computation of very high degree and order - normalised associated Legendre functions", - *Journal of Geodesy*, 76, 279--299, (2002). - `doi: 10.1007/s00190-002-0216-2 `_ """ # removing singleton dimensions of x @@ -302,9 +270,9 @@ def plm_mohlenkamp(LMAX, x, ): """ Computes fully-normalized associated Legendre Polynomials and their - first derivative using the recursion relation from [Mohlenkamp2016]_ + first derivative using the recursion relation from :cite:p:`Mohlenkamp:2016vv` - Derived from [Szego1939]_ recurrence formula for Jacobi Polynomials + Derived from :cite:p:`Szego:1939tn` recurrence formula for Jacobi Polynomials Parameters ---------- @@ -325,16 +293,6 @@ def plm_mohlenkamp(LMAX, x, fully-normalized Legendre polynomials dplms: np.ndarray first derivative of Legendre polynomials - - References - ---------- - .. [Mohlenkamp2016] M. J. Mohlenkamp, - "A User's Guide to Spherical Harmonics", (2016). - `[pdf] `_ - .. [Szego1939] Gabor Szeg\ |ouml|\ , "Orthogonal Polynomials", 440 pp., (1939). - `[pdf] `_ - - .. |ouml| unicode:: U+00F6 .. LATIN SMALL LETTER O WITH DIAERESIS """ # Verify LMAX as integer diff --git a/gravity_toolkit/clenshaw_summation.py b/gravity_toolkit/clenshaw_summation.py index c1170bca..19a9b681 100644 --- a/gravity_toolkit/clenshaw_summation.py +++ b/gravity_toolkit/clenshaw_summation.py @@ -79,7 +79,7 @@ def clenshaw_summation(clm, slm, lon, lat, ): r""" Calculates the spatial field for a series of spherical harmonics for a - sequence of ungridded points + sequence of ungridded points :cite:p:`Holmes:2002ff` :cite:p:`Tscherning:1982tu` Parameters ---------- @@ -98,10 +98,10 @@ def clenshaw_summation(clm, slm, lon, lat, - ``1``: cm water equivalent thickness (cm w.e., g/cm\ :sup:`2`) - ``2``: mm geoid height - - ``3``: mm elastic crustal deformation + - ``3``: mm elastic crustal deformation :cite:p:`Davis:2004il` - ``4``: microGal gravitational perturbation - ``5``: mbar equivalent surface pressure - - ``6``: cm viscoelastic crustal uplift (GIA) + - ``6``: cm viscoelastic crustal uplift (GIA) :cite:p:`Wahr:2000ek` - list: custom degree-dependent unit conversion factor LMAX: int, default 0 Upper bound of Spherical Harmonic Degrees @@ -116,29 +116,6 @@ def clenshaw_summation(clm, slm, lon, lat, ------- spatial: np.ndarray calculated spatial field for latitude and longitude - - References - ---------- - .. [Davis2004] J. L. Davis et al., - "Climate-driven deformation of the solid Earth from GRACE and GPS", - *Geophysical Research Letters*, 31(L24605), (2004). - `doi: 10.1029/2004GL021435 `_ - - .. [Holmes2002] S. A. Holmes and W. E. Featherstone, - "A unified approach to the Clenshaw summation and the recursive - computation of very high degree and order normalised associated - Legendre functions", *Journal of Geodesy*, 76, 279--299, (2002). - `doi: 10.1007/s00190-002-0216-2 `_ - - .. [Tscherning1982] C. C. Tscherning and K. Poder, - "Some Geodetic Applications of Clenshaw Summation", - *Bollettino di Geodesia e Scienze*, 4, 349--375, (1982). - - .. [Wahr2000] J. Wahr, D. Wingham, and C. Bentley, - "A method of combining ICESat and GRACE satellite data to constrain - Antarctic mass balance", *Journal of Geophysical Research: Solid Earth*, - 105(B7), 16279--16294, (2000). - `doi: 10.1029/2000JB900113 `_ """ # check if lat and lon are the same size diff --git a/gravity_toolkit/destripe_harmonics.py b/gravity_toolkit/destripe_harmonics.py index 184c0c74..932c0e07 100644 --- a/gravity_toolkit/destripe_harmonics.py +++ b/gravity_toolkit/destripe_harmonics.py @@ -69,6 +69,7 @@ def destripe_harmonics( ): """ Filters spherical harmonic coefficients for correlated striping errors + :cite:p:`Swenson:2006hu` Parameters ---------- @@ -93,13 +94,6 @@ def destripe_harmonics( filtered cosine spherical harmonic coefficients slm: np.ndarray filtered sine spherical harmonic coefficients - - References - ---------- - .. [Swenson2006] S. Swenson and J. Wahr, - "Post-processing removal of correlated errors in GRACE data", - *Geophysical Research Letters*, 33(L08402), (2006). - `doi: 10.1029/2005GL025285 `_ """ # tests if spherical harmonics have been imported diff --git a/gravity_toolkit/gauss_weights.py b/gravity_toolkit/gauss_weights.py index c4af13c4..29849fba 100755 --- a/gravity_toolkit/gauss_weights.py +++ b/gravity_toolkit/gauss_weights.py @@ -52,7 +52,7 @@ def gauss_weights(hw, LMAX, CUTOFF=1e-10): """ Computes the Gaussian weights as a function of degree using - a normalized form of [Jekeli1981]_ + a normalized form of :cite:p:`Jekeli:1981vj` Parameters ---------- @@ -67,12 +67,6 @@ def gauss_weights(hw, LMAX, CUTOFF=1e-10): ------- wl: np.ndarray degree dependent weighting function - - References - ---------- - .. [Jekeli1981] C. Jekeli, "Alternative Methods to Smooth - the Earth's Gravity Field", NASA Grant No. NGR 36-008-161, - OSURF Proj. No. 783210, 48 pp., (1981). """ # allocate for output weights wl = np.zeros((LMAX+1)) diff --git a/gravity_toolkit/gen_averaging_kernel.py b/gravity_toolkit/gen_averaging_kernel.py index 3f58d3cb..429a07f2 100755 --- a/gravity_toolkit/gen_averaging_kernel.py +++ b/gravity_toolkit/gen_averaging_kernel.py @@ -61,10 +61,10 @@ def gen_averaging_kernel(gclm, gslm, eclm, eslm, sigma, hw, LMAX=60, MMAX=None, CUTOFF=1e-15, UNITS=0, LOVE=None): r""" Generates averaging kernel coefficients which minimize the - total error following [Swenson2002]_ + total error following :cite:p:`Swenson:2002hs` Uses a normalized form of the Gaussian averaging function - from [Jekeli1981]_ + from :cite:p:`Jekeli:1981vj` Parameters ---------- @@ -100,18 +100,6 @@ def gen_averaging_kernel(gclm, gslm, eclm, eslm, sigma, hw, cosine coefficients of the averaging kernel slm: np.ndarray sine coefficients of the averaging kernel - - References - ---------- - .. [Jekeli1981] C. Jekeli, "Alternative Methods to Smooth - the Earth's Gravity Field", NASA Grant No. NGR 36-008-161, - OSURF Proj. No. 783210, 48 pp., (1981). - - .. [Swenson2002] S. Swenson and J. Wahr, "Methods for inferring regional - surface-mass anomalies from Gravity Recovery and Climate Experiment - (GRACE) measurements of time-variable gravity", *Journal of - Geophysical Research: Solid Earth*, 107(B9), 2193, (2002). - `doi: 10.1029/2001JB000576 `_ """ # upper bound of spherical harmonic orders (default = LMAX) if MMAX is None: diff --git a/gravity_toolkit/gen_disc_load.py b/gravity_toolkit/gen_disc_load.py index c54bdc7f..015b3916 100644 --- a/gravity_toolkit/gen_disc_load.py +++ b/gravity_toolkit/gen_disc_load.py @@ -84,6 +84,8 @@ def gen_disc_load(data, lon, lat, area, LMAX=60, MMAX=None, UNITS=2, PLM=None, LOVE=None): r""" Calculates spherical harmonic coefficients for a uniform disc load + :cite:p:`Holmes:2002ff` :cite:p:`Longman:1962ev` :cite:p:`Farrell:1972cm` + :cite:p:`Pollack:1973gi` :cite:p:`Jacob:2012eo` Parameters ---------- @@ -121,28 +123,6 @@ def gen_disc_load(data, lon, lat, area, LMAX=60, MMAX=None, UNITS=2, spherical harmonic degree to LMAX m: np.ndarray spherical harmonic order to MMAX - - References - ---------- - .. [Holmes2002] S. A. Holmes and W. E. Featherstone, - "A unified approach to the Clenshaw summation and the recursive - computation of very high degree and order normalised associated - Legendre functions", *Journal of Geodesy*, 76, 279--299, (2002). - `doi: 10.1007/s00190-002-0216-2 `_ - .. [Longman1962] I. M. Longman, "A Green's function for determining - the deformation of the Earth under surface mass loads: 1. Theory", - *Journal of Geophysical Research*, 67(2), (1962). - `doi: 10.1029/JZ067i002p00845 `_ - .. [Farrell1972] W. E. Farrell, "Deformation of the Earth by surface loads", - *Reviews of Geophysics and Space Physics*, 10(3), (1972). - `doi: 10.1029/RG010i003p00761 `_ - .. [Pollack1973] H. N. Pollack, "Spherical harmonic representation of the - gravitational potential of a point mass, a spherical cap, and a - spherical rectangle", *Journal of Geophysical Research*, 78(11), (1973). - `doi: 10.1029/JB078i011p01760 `_ - .. [Jacob2012] T. Jacob et al., "Estimating geoid height change in North America: - past, present and future", *Journal of Geodesy*, 86, 337-358, (2012). - `doi: 10.1007/s00190-011-0522-7 `_ """ # upper bound of spherical harmonic orders (default = LMAX) diff --git a/gravity_toolkit/gen_point_load.py b/gravity_toolkit/gen_point_load.py index 9d6dd655..8cf05d8d 100644 --- a/gravity_toolkit/gen_point_load.py +++ b/gravity_toolkit/gen_point_load.py @@ -65,6 +65,7 @@ def gen_point_load(data, lon, lat, LMAX=60, MMAX=None, UNITS=1, LOVE=None): """ Calculates spherical harmonic coefficients for point masses + :cite:p:`Longman:1962ev` :cite:p:`Farrell:1972cm` :cite:p:`Pollack:1973gi` Parameters ---------- @@ -97,20 +98,6 @@ def gen_point_load(data, lon, lat, LMAX=60, MMAX=None, UNITS=1, LOVE=None): spherical harmonic degree to LMAX m: np.ndarray spherical harmonic order to MMAX - - References - ---------- - .. [Longman1962] I. M. Longman, "A Green's function for determining - the deformation of the Earth under surface mass loads: 1. Theory", - *Journal of Geophysical Research*, 67(2), (1962). - `doi: 10.1029/JZ067i002p00845 `_ - .. [Farrell1972] W. E. Farrell, "Deformation of the Earth by surface loads", - *Reviews of Geophysics and Space Physics*, 10(3), (1972). - `doi: 10.1029/RG010i003p00761 `_ - .. [Pollack1973] H. N. Pollack, "Spherical harmonic representation of the - gravitational potential of a point mass, a spherical cap, and a - spherical rectangle", *Journal of Geophysical Research*, 78(11), (1973). - `doi: 10.1029/JB078i011p01760 `_ """ # upper bound of spherical harmonic orders (default == LMAX) diff --git a/gravity_toolkit/gen_spherical_cap.py b/gravity_toolkit/gen_spherical_cap.py index 1a21b576..208d8888 100755 --- a/gravity_toolkit/gen_spherical_cap.py +++ b/gravity_toolkit/gen_spherical_cap.py @@ -102,6 +102,8 @@ def gen_spherical_cap(data, lon, lat, LMAX=60, MMAX=None, AREA=0, RAD_CAP=0, RAD_KM=0, UNITS=1, PLM=None, LOVE=None): r""" Calculates spherical harmonic coefficients for a spherical cap + :cite:p:`Holmes:2002ff` :cite:p:`Longman:1962ev` :cite:p:`Farrell:1972cm` + :cite:p:`Pollack:1973gi` :cite:p:`Jacob:2012eo` Parameters ---------- @@ -139,28 +141,6 @@ def gen_spherical_cap(data, lon, lat, LMAX=60, MMAX=None, spherical harmonic degree to LMAX m: np.ndarray spherical harmonic order to MMAX - - References - ---------- - .. [Holmes2002] S. A. Holmes and W. E. Featherstone, - "A unified approach to the Clenshaw summation and the recursive - computation of very high degree and order normalised associated - Legendre functions", *Journal of Geodesy*, 76, 279--299, (2002). - `doi: 10.1007/s00190-002-0216-2 `_ - .. [Longman1962] I. M. Longman, "A Green's function for determining - the deformation of the Earth under surface mass loads: 1. Theory", - *Journal of Geophysical Research*, 67(2), (1962). - `doi: 10.1029/JZ067i002p00845 `_ - .. [Farrell1972] W. E. Farrell, "Deformation of the Earth by surface loads", - *Reviews of Geophysics and Space Physics*, 10(3), (1972). - `doi: 10.1029/RG010i003p00761 `_ - .. [Pollack1973] H. N. Pollack, "Spherical harmonic representation of the - gravitational potential of a point mass, a spherical cap, and a - spherical rectangle", *Journal of Geophysical Research*, 78(11), (1973). - `doi: 10.1029/JB078i011p01760 `_ - .. [Jacob2012] T. Jacob et al., "Estimating geoid height change in North America: - past, present and future", *Journal of Geodesy*, 86, 337-358, (2012). - `doi: 10.1007/s00190-011-0522-7 `_ """ # upper bound of spherical harmonic orders (default = LMAX) diff --git a/gravity_toolkit/gen_stokes.py b/gravity_toolkit/gen_stokes.py index 712169b5..5856ee35 100755 --- a/gravity_toolkit/gen_stokes.py +++ b/gravity_toolkit/gen_stokes.py @@ -79,7 +79,8 @@ def gen_stokes(data, lon, lat, LMIN=0, LMAX=60, MMAX=None, UNITS=1, PLM=None, LOVE=None): r""" - Converts data from the spatial domain to spherical harmonic coefficients + Converts data from the spatial domain to spherical harmonic + coefficients :cite:p:`Wahr:1998hy` Parameters ---------- @@ -117,14 +118,6 @@ def gen_stokes(data, lon, lat, LMIN=0, LMAX=60, MMAX=None, UNITS=1, spherical harmonic degree to LMAX m: np.ndarray spherical harmonic order to MMAX - - References - ---------- - .. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time - variability of the Earth's gravity field: Hydrological - and oceanic effects and their possible detection using GRACE", - *Journal of Geophysical Research*, 103(B12), 30205-30229, (1998). - `doi: 10.1029/98JB02844 `_ """ # converting LMIN and LMAX to integer diff --git a/gravity_toolkit/geocenter.py b/gravity_toolkit/geocenter.py index aac4aaba..c30b5627 100644 --- a/gravity_toolkit/geocenter.py +++ b/gravity_toolkit/geocenter.py @@ -188,10 +188,8 @@ def from_AOD1B(self, release, year, month, product='glo'): def from_gravis(self, geocenter_file, **kwargs): """ Reads monthly geocenter spherical harmonic data files from - `GFZ GravIS calculated using GRACE/GRACE-FO measurements - and Ocean Models of degree 1 - `_ - + GFZ GravIS calculated using GRACE/GRACE-FO measurements + and Ocean Models of degree 1 :cite:p:`Dahle:2019cu` Parameters ---------- @@ -199,13 +197,6 @@ def from_gravis(self, geocenter_file, **kwargs): degree 1 file header: bool, default True file contains header text to be skipped - - References - ---------- - .. [Dahle2019] Dahle and Murboeck, "Post-processed GRACE/GRACE-FO - Geopotential GSM Coefficients GFZ RL06 (Level-2B Product)." - V. 0002. *GFZ Data Services*, (2019). - `doi: 10.5880/GFZ.GRAVIS_06_L2B `_ """ # set filename @@ -444,24 +435,13 @@ def from_SLR(self, geocenter_file, **kwargs): def from_UCI(self, geocenter_file, **kwargs): """ Reads monthly geocenter files computed using GRACE/GRACE-FO - measurements and ocean models [Swenson2008]_ [Sutterley2019]_ + measurements and ocean models :cite:p:`Swenson:2008cr` + :cite:p:`Sutterley:2019bx` Parameters ---------- geocenter_file: str input datafile with geocenter coefficients - - References - ---------- - .. [Swenson2008] S. Swenson, D. Chambers, and J. Wahr, - "Estimating geocenter variations from a combination - of GRACE and ocean model output", *Journal of Geophysical - Research*, 113(B08410), (2008). - `doi: 10.1029/2007JB005338 `_ - .. [Sutterley2019] T. C. Sutterley, and I. Velicogna, "Improved - estimates of geocenter variability from time-variable gravity - and ocean model outputs", *Remote Sensing*, 11(18), 2108, (2019). - `doi: 10.3390/rs11182108 `_ """ # set filename self.case_insensitive_filename(geocenter_file) @@ -544,7 +524,7 @@ def from_swenson(self, geocenter_file, **kwargs): Reads `monthly geocenter coefficients `_ computed by Sean Swenson using GRACE/GRACE-FO measurements - and Ocean Models of degree 1 + and Ocean Models of degree 1 :cite:p:`Swenson:2008cr` Parameters ---------- @@ -552,14 +532,6 @@ def from_swenson(self, geocenter_file, **kwargs): degree 1 file header: bool, default True file contains header text to be skipped - - References - ---------- - .. [Swenson2008] S. Swenson, D. Chambers, and J. Wahr, - "Estimating geocenter variations from a combination - of GRACE and ocean model output", *Journal of Geophysical - Research*, 113(B08410), (2008). - `doi: 10.1029/2007JB005338 `_ """ # set filename self.case_insensitive_filename(geocenter_file) @@ -645,7 +617,8 @@ def from_tellus(self, geocenter_file, **kwargs): """ Reads monthly geocenter spherical harmonic data files from GRACE Tellus Technical Notes (TN-13) calculated using GRACE/GRACE-FO measurements and - Ocean Models of Degree 1 + Ocean Models of Degree 1 :cite:p:`Swenson:2008cr` :cite:p:`Sun:2016bf` + :cite:p:`Sun:2016hh` Datasets distributed by NASA PO.DAAC @@ -661,25 +634,6 @@ def from_tellus(self, geocenter_file, **kwargs): file contains header text to be skipped JPL: bool, default True use JPL TN-13 geocenter files with self-attraction and loading - - References - ---------- - .. [Swenson2008] S. Swenson, D. Chambers, and J. Wahr, - "Estimating geocenter variations from a combination - of GRACE and ocean model output", *Journal of Geophysical - Research*, 113(B08410), (2008). - `doi: 10.1029/2007JB005338 `_ - - .. [Sun2016a] Y. Sun, R. Riva, and P. Ditmar, "Observed changes - in the Earth's dynamic oblateness from GRACE data and - geophysical models", *Journal of Geodesy*, 90(1), 81-89, (2016). - `doi: 10.1007/s00190-015-0852-y `_ - - .. [Sun2016b] Y. Sun, R. Riva, and P. Ditmar, "Optimizing estimates of - annual variations and trends in geocenter motion and J2 from - a combination of GRACE data and geophysical models", - *Journal of Geophysical Research: Solid Earth*, 121, (2016). - `doi: 10.1002/2016JB013073 `_ """ # set filename self.case_insensitive_filename(geocenter_file) @@ -788,7 +742,7 @@ def from_tellus(self, geocenter_file, **kwargs): def from_netCDF4(self, geocenter_file, group=None, **kwargs): """ Reads geocenter file and extracts dates and spherical harmonic data - from a netCDF4 file + from a netCDF4 file :cite:p:`Sutterley:2019bx` Parameters ---------- @@ -798,13 +752,6 @@ def from_netCDF4(self, geocenter_file, group=None, **kwargs): netCDF4 group name compression: str or NoneType, default None file compression type - - References - ---------- - .. [Sutterley2019] T. C. Sutterley, and I. Velicogna, "Improved - estimates of geocenter variability from time-variable gravity - and ocean model outputs", *Remote Sensing*, 11(18), 2108, (2019). - `doi: 10.3390/rs11182108 `_ """ kwargs.setdefault('compression', None) # set filename diff --git a/gravity_toolkit/grace_input_months.py b/gravity_toolkit/grace_input_months.py index 97ae098f..b4cb61d7 100644 --- a/gravity_toolkit/grace_input_months.py +++ b/gravity_toolkit/grace_input_months.py @@ -196,9 +196,10 @@ def grace_input_months(base_dir, PROC, DREL, DSET, LMAX, start_mon, end_mon, Can replace low-degree harmonics with SLR values for months 179+ - Can correct for ECMWF atmospheric "jumps" using GAE/GAF/GAG files [Fagiolini2015]_ + Can correct for ECMWF atmospheric "jumps" using GAE/GAF/GAG files + :cite:p:`Fagiolini:2015kc` - Can correct for Pole Tide drift following [Wahr2015]_ + Can correct for Pole Tide drift following :cite:p:`Wahr:2015dg` Parameters ---------- @@ -243,15 +244,11 @@ def grace_input_months(base_dir, PROC, DREL, DSET, LMAX, start_mon, end_mon, Use Degree 1 coefficients - ``None``: No degree 1 replacement - - ``'Tellus'``: `GRACE/GRACE-FO TN-13 coefficients from PO.DAAC - `_ [Sun2016]_ - - ``'SLR'``: `Satellite laser ranging coefficients from CSR - `_ [Cheng2013]_ - - ``'UCI'``: `GRACE/GRACE-FO coefficients from Sutterley and Velicogna - `_ [Sutterley2019]_ - - ``'Swenson'``: GRACE-derived coefficients from Sean Swenson [Swenson2008]_ - - ``'GFZ'``: `GRACE/GRACE-FO coefficients from GFZ GravIS - `_ + - ``'Tellus'``: TN-13 coefficients from PO.DAAC :cite:p:`Sun:2016bf` + - ``'SLR'``: Satellite laser ranging coefficients from CSR :cite:p:`Cheng:2013tz` + - ``'UCI'``: GRACE/GRACE-FO coefficients from :cite:p:`Sutterley:2019bx` + - ``'Swenson'``: GRACE-derived coefficients from :cite:p:`Swenson:2008cr` + - ``'GFZ'``: GFZ GravIS coefficients MMAX: int or NoneType, default None Upper bound of Spherical Harmonic Orders SLR_21: str or NoneType, default '' @@ -287,9 +284,9 @@ def grace_input_months(base_dir, PROC, DREL, DSET, LMAX, start_mon, end_mon, - ``'CSR'``: use values from CSR (5x5 with 6,1) - ``'GSFC'``: use values from GSFC POLE_TIDE: bool, default False - Correct GSM data with pole tides following [Wahr2015]_ + Correct GSM data with pole tides following :cite:p:`Wahr:2015dg` ATM: bool, default False - Correct data with ECMWF "jump" corrections following [Fagiolini2015]_ + Correct data with ECMWF "jump" corrections following :cite:p:`Fagiolini:2015kc` DEG1_FILE: str or NoneType, default None full path to degree 1 coefficients file MODEL_DEG1: bool, default False @@ -320,39 +317,6 @@ def grace_input_months(base_dir, PROC, DREL, DSET, LMAX, start_mon, end_mon, Directory of exact GRACE/GRACE-FO/Swarm product attributes: dict Attributes of input files and corrections - - References - ---------- - .. [Cheng2013] M. Cheng, "Geocenter Variations from Analysis of SLR Data", - *Reference Frames for Applications in Geosciences*, 19--25, (2013). - `doi: 10.1007/978-3-642-32998-2_4 `_ - - .. [Fagiolini2015] E. Fagiolini, F. Flechtner, M. Horwath, and H. Dobslaw, - "Correction of inconsistencies in ECMWF's operational analysis data - during de-aliasing of GRACE gravity models", - *Geophysical Journal International*, 202(3), 2150--2158, (2015). - `doi: 10.1093/gji/ggv276 `_ - - .. [Sun2016] Y. Sun, P. Ditmar, and R. Riva, "Observed changes in the - Earth's dynamic oblateness from GRACE data and geophysical models", - *Journal of Geodesy*, 90(1), 81--89, (2016). - `doi: 10.1007/s00190-015-0852-y `_ - - .. [Sutterley2019] T. C. Sutterley and I. Velicogna, "Improved - Estimates of Geocenter Variability from Time-Variable Gravity - and Ocean Model Outputs", *Remote Sensing*, 11(18), 2108, (2019). - `doi: 10.3390/rs11182108 `_ - - .. [Swenson2008] S. Swenson, D. Chambers, and J. Wahr, "Estimating geocenter - variations from a combination of GRACE and ocean model output", - *Journal of Geophysical Research: Solid Earth*, 113(B08410), (2008). - `doi: 10.1029/2007JB005338 `_ - - .. [Wahr2015] J. Wahr, R. S. Nerem, and S. V. Bettadpur, "The pole tide - and its effect on GRACE time-variable gravity measurements: - Implications for estimates of surface mass variations". - *Journal of Geophysical Research: Solid Earth*, 120(6), 4597--4615, (2015). - `doi: 10.1002/2015JB011986 `_ """ # set default keyword arguments kwargs.setdefault('MMAX',LMAX) @@ -869,7 +833,7 @@ def grace_input_months(base_dir, PROC, DREL, DSET, LMAX, start_mon, end_mon, # PURPOSE: read atmospheric jump corrections from Fagiolini et al. (2015) def read_ecmwf_corrections(base_dir, LMAX, months, MMAX=None): """ - Read atmospheric jump corrections from [Fagiolini2015]_ + Read atmospheric jump corrections from :cite:p:`Fagiolini:2015kc` Parameters ---------- @@ -890,15 +854,6 @@ def read_ecmwf_corrections(base_dir, LMAX, months, MMAX=None): atmospheric correction sine spherical harmonics files: list atmospheric correction files - - References - ---------- - .. [Fagiolini2015] E. Fagiolini, F. Flechtner, M. Horwath, and H. Dobslaw, - "Correction of inconsistencies in ECMWF's operational analysis data - during de-aliasing of GRACE gravity models", - *Geophysical Journal International*, 202(3), 2150--2158, (2015). - `doi: 10.1093/gji/ggv276 `_ - """ # correction files corr_file = {} diff --git a/gravity_toolkit/harmonic_gradients.py b/gravity_toolkit/harmonic_gradients.py index 72ef16a9..dfc5ae37 100644 --- a/gravity_toolkit/harmonic_gradients.py +++ b/gravity_toolkit/harmonic_gradients.py @@ -162,7 +162,7 @@ def geostrophic_currents(clm1, slm1, lon, lat, r""" Converts data from spherical harmonic coefficients to a spatial fields of ocean geostrophic currents following - [Wahr2002]_ + :cite:p:`Wahr:1998hy` :cite:p:`Wahr:2002ie` Parameters ---------- @@ -195,20 +195,6 @@ def geostrophic_currents(clm1, slm1, lon, lat, ------- currents: np.ndarray zonal and meridional current fields [cm/s] - - References - ---------- - .. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time - variability of the Earth's gravity field: Hydrological - and oceanic effects and their possible detection using GRACE", - *Journal of Geophysical Research*, 103(B12), 30205-30229, (1998). - `doi: 10.1029/98JB02844 `_ - - .. [Wahr2002] J. M. Wahr, S. R. Jayne, and F. O. Bryan, - "A method of inferring changes in deep ocean currents from - satellite measurements of time-variable gravity", - *Journal of Geophysical Research: Oceans*, 107(C12), 3218, (2002). - `doi: 10.1029/2001JC001274 `_ """ # if LMAX is not specified, will use the size of the input harmonics diff --git a/gravity_toolkit/harmonic_summation.py b/gravity_toolkit/harmonic_summation.py index 042e286a..3eed02ce 100755 --- a/gravity_toolkit/harmonic_summation.py +++ b/gravity_toolkit/harmonic_summation.py @@ -198,6 +198,7 @@ def stokes_summation(clm1, slm1, lon, lat, LMIN=0, LMAX=60, MMAX=None, RAD=0, UNITS=0, LOVE=None, PLM=None): r""" Converts data from spherical harmonic coefficients to a spatial field + :cite:p:`Wahr:1998hy` Parameters ---------- @@ -222,10 +223,10 @@ def stokes_summation(clm1, slm1, lon, lat, - ``1``: cm water equivalent thickness (cm w.e., g/cm\ :sup:`2`) - ``2``: mm geoid height - - ``3``: mm elastic crustal deformation + - ``3``: mm elastic crustal deformation :cite:p:`Davis:2004il` - ``4``: microGal gravitational perturbation - ``5``: mbar equivalent surface pressure - - ``6``: cm viscoelastic crustal uplift (GIA) + - ``6``: cm viscoelastic crustal uplift (GIA) :cite:p:`Wahr:2000ek` - list: custom degree-dependent unit conversion factor LMAX: int, default 0 Upper bound of Spherical Harmonic Degrees @@ -238,35 +239,6 @@ def stokes_summation(clm1, slm1, lon, lat, ------- spatial: np.ndarray spatial field - - References - ---------- - .. [Davis2004] J. L. Davis et al., - "Climate-driven deformation of the solid Earth from GRACE and GPS", - *Geophysical Research Letters*, 31(L24605), (2004). - `doi: 10.1029/2004GL021435 `_ - - .. [Holmes2002] S. A. Holmes and W. E. Featherstone, - "A unified approach to the Clenshaw summation and the recursive - computation of very high degree and order normalised associated - Legendre functions", *Journal of Geodesy*, 76, 279--299, (2002). - `doi: 10.1007/s00190-002-0216-2 `_ - - .. [Tscherning1982] C. C. Tscherning and K. Poder, - "Some Geodetic Applications of Clenshaw Summation", - *Bollettino di Geodesia e Scienze*, 4, 349--375, (1982). - - .. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, "Time - variability of the Earth's gravity field: Hydrological - and oceanic effects and their possible detection using GRACE", - *Journal of Geophysical Research*, 103(B12), 30205-30229, (1998). - `doi: 10.1029/98JB02844 `_ - - .. [Wahr2000] J. Wahr, D. Wingham, and C. Bentley, - "A method of combining ICESat and GRACE satellite data to constrain - Antarctic mass balance", *Journal of Geophysical Research: Solid Earth*, - 105(B7), 16279--16294, (2000). - `doi: 10.1029/2000JB900113 `_ """ # if LMAX is not specified, will use the size of the input harmonics if (LMAX == 0): diff --git a/gravity_toolkit/harmonics.py b/gravity_toolkit/harmonics.py index 3d042a96..f0212757 100644 --- a/gravity_toolkit/harmonics.py +++ b/gravity_toolkit/harmonics.py @@ -1793,19 +1793,12 @@ def convolve(self, var): def destripe(self, **kwargs): """ Filters spherical harmonic coefficients for correlated "striping" - errors following [Swenson2006]_ + errors following :cite:p:`Swenson:2006hu` Parameters ---------- kwargs: dict keyword arguments for ``destripe_harmonics`` - - References - ---------- - .. [Swenson2006] S. Swenson and J. Wahr, - "Post-processing removal of correlated errors in GRACE data", - *Geophysical Research Letters*, 33(L08402), (2006). - `doi: 10.1029/2005GL025285 `_ """ # assign degree and order fields self.update_dimensions() diff --git a/gravity_toolkit/legendre.py b/gravity_toolkit/legendre.py index 207b2cec..ebb6a9d3 100644 --- a/gravity_toolkit/legendre.py +++ b/gravity_toolkit/legendre.py @@ -45,7 +45,7 @@ def legendre(l, x, NORMALIZE=False): """ Computes associated Legendre functions for a particular degree - following [Abramowitz1965]_ and [Jacobs1987]_ + following :cite:p:`Abramowitz:1965vw` and :cite:p:`Jacobs:1987vv` Parameters ---------- @@ -62,14 +62,6 @@ def legendre(l, x, NORMALIZE=False): ------- Pl: np.ndarray legendre polynomials of degree ``l`` - - References - ---------- - .. [Abramowitz1965] M. Abramowitz and I. A. Stegun, - *Handbook of Mathematical Functions*, 1046 pp., (1965). - - .. [Jacobs1987] J. A. Jacobs, *Geomagnetism*, - Volume 1, 1st Edition, 832 pp., (1987). """ # verify integer l = np.int64(l) diff --git a/gravity_toolkit/legendre_polynomials.py b/gravity_toolkit/legendre_polynomials.py index 7f4f2f49..c2e429b5 100755 --- a/gravity_toolkit/legendre_polynomials.py +++ b/gravity_toolkit/legendre_polynomials.py @@ -49,7 +49,7 @@ def legendre_polynomials(lmax, x, ASTYPE=np.float64): """ Computes fully-normalized Legendre polynomials and their first derivative - following [HofmannWellenhof2006]_ + following :cite:p:`HofmannWellenhof:2006hy` Parameters ---------- @@ -68,13 +68,6 @@ def legendre_polynomials(lmax, x, ASTYPE=np.float64): fully-normalized Legendre polynomials dpl: np.ndarray first derivative of Legendre polynomials - - References - ---------- - .. [HofmannWellenhof2006] B. Hofmann-Wellenhof and H. Moritz, - *Physical Geodesy*, 2nd Edition, 403 pp., (2006). - `doi: 10.1007/978-3-211-33545-1 - `_ """ # verify dimensions x = np.atleast_1d(x).flatten().astype(ASTYPE) diff --git a/gravity_toolkit/mascons.py b/gravity_toolkit/mascons.py index b3e7e353..2a8f08c1 100644 --- a/gravity_toolkit/mascons.py +++ b/gravity_toolkit/mascons.py @@ -32,6 +32,7 @@ def to_gsfc(gdata, lon, lat, lon_center, lat_center, lon_span, lat_span): """ Converts an input gridded field to an output GSFC mascon array + :cite:p:`Luthcke:2013ep` Parameters ---------- @@ -58,15 +59,6 @@ def to_gsfc(gdata, lon, lat, lon_center, lat_center, lon_span, lat_span): row vector of latitude values for mascon centers lon_center: np.ndarray row vector of longitude values for mascon centers - - References - ---------- - .. [Luthcke2013] S. B. Luthcke, T. J. Sabaka, B. D. Loomis, - A. A. Arendt, J. J. McCarthy, and J. Camp, - "Antarctica, Greenland and Gulf of Alaska land-ice evolution - from an iterated GRACE global mascon solution", - *Journal of Glaciology*, 59(216), (2013). - `doi: 10.3189/2013JoG12J147 `_ """ # number of mascons nmas = len(lon_center) @@ -121,6 +113,7 @@ def to_gsfc(gdata, lon, lat, lon_center, lat_center, lon_span, lat_span): def to_jpl(gdata, lon, lat, lon_bound, lat_bound): """ Converts an input gridded field to an output JPL mascon array + :cite:p:`Watkins:2015jl` Parameters ---------- @@ -145,14 +138,6 @@ def to_jpl(gdata, lon, lat, lon_bound, lat_bound): row vector of latitude values for mascons lon: np.ndarray row vector of longitude values for mascons - - References - ---------- - .. [Watkins2015] M. M. Watkins, D. N. Wiese, D.-N. Yuan, C. Boening, - and F. W. Landerer, "Improved methods for observing Earth's time - variable mass distribution with GRACE using spherical cap mascons". - *Journal of Geophysical Research: Solid Earth*, 120(4), 2648--2671, - (2015). `doi: 10.1002/2014JB011547 `_ """ # mascon dimensions nmas,nvar = lat_bound.shape @@ -196,6 +181,7 @@ def from_gsfc(mscdata, grid_spacing, lon_center, lat_center, lon_span, lat_span, **kwargs): """ Converts an input GSFC mascon array to an output gridded field + :cite:p:`Luthcke:2013ep` Parameters ---------- @@ -218,15 +204,6 @@ def from_gsfc(mscdata, grid_spacing, lon_center, lat_center, lon_span, lat_span, ------- mdata: np.ndarray distributed mass grid - - References - ---------- - .. [Luthcke2013] S. B. Luthcke, T. J. Sabaka, B. D. Loomis, - A. A. Arendt, J. J. McCarthy, and J. Camp, - "Antarctica, Greenland and Gulf of Alaska land-ice evolution - from an iterated GRACE global mascon solution", - *Journal of Glaciology*, 59(216), (2013). - `doi: 10.3189/2013JoG12J147 `_ """ # set default keyword arguments kwargs.setdefault('transpose', False) @@ -289,6 +266,7 @@ def from_gsfc(mscdata, grid_spacing, lon_center, lat_center, lon_span, lat_span, def from_jpl(mscdata, grid_spacing, lon_bound, lat_bound, **kwargs): """ Converts an input JPL mascon array to an output gridded field + :cite:p:`Watkins:2015jl` Parameters ---------- @@ -307,14 +285,6 @@ def from_jpl(mscdata, grid_spacing, lon_bound, lat_bound, **kwargs): ------- mdata: np.ndarray distributed mass grid - - References - ---------- - .. [Watkins2015] M. M. Watkins, D. N. Wiese, D.-N. Yuan, C. Boening, - and F. W. Landerer, "Improved methods for observing Earth's time - variable mass distribution with GRACE using spherical cap mascons". - *Journal of Geophysical Research: Solid Earth*, 120(4), 2648--2671, - (2015). `doi: 10.1002/2014JB011547 `_ """ # set default keyword arguments kwargs.setdefault('transpose', False) diff --git a/gravity_toolkit/read_GIA_model.py b/gravity_toolkit/read_GIA_model.py index 466622f0..39da6de0 100755 --- a/gravity_toolkit/read_GIA_model.py +++ b/gravity_toolkit/read_GIA_model.py @@ -162,15 +162,15 @@ def read_GIA_model(input_file, GIA=None, MMAX=None, DATAFORM=None, **kwargs): GIA: str or NoneType, default None GIA model type to read and output - - ``'IJ05-R2'``: Ivins R2 GIA Models [Ivins2013]_ - - ``'W12a'``: Whitehouse GIA Models [Whitehouse2012]_ - - ``'SM09'``: Simpson/Milne GIA Models [Simpson2009]_ - - ``'ICE6G'``: ICE-6G GIA Models [Peltier2015]_ - - ``'Wu10'``: Wu (2010) GIA Correction [Wu2010]_ - - ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models [A2013]_ - - ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models [A2013]_ - - ``'Caron'``: Caron JPL GIA Assimilation [Caron2018]_ - - ``'ICE6G-D'``: ICE-6G Version-D GIA Models [Peltier2018]_ + - ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq` + - ``'W12a'``: Whitehouse GIA Models :cite:p:`Whitehouse:2012jj` + - ``'SM09'``: Simpson/Milne GIA Models :cite:p:`Simpson:2009hg` + - ``'ICE6G'``: ICE-6G GIA Models :cite:p:`Peltier:2015bo` + - ``'Wu10'``: Wu (2010) GIA Correction :cite:p:`Wu:2010dq` + - ``'AW13-ICE6G'``: Geruo A ICE-6G GIA Models :cite:p:`A:2013kh` + - ``'AW13-IJ05'``: Geruo A IJ05-R2 GIA Models :cite:p:`A:2013kh` + - ``'Caron'``: Caron JPL GIA Assimilation :cite:p:`Caron:2018ba` + - ``'ICE6G-D'``: ICE-6G Version-D GIA Models :cite:p:`Peltier:2018dp` - ``'ascii'``: reformatted GIA in ascii format - ``'netCDF4'``: reformatted GIA in netCDF4 format - ``'HDF5'``: reformatted GIA in HDF5 format @@ -208,52 +208,6 @@ def read_GIA_model(input_file, GIA=None, MMAX=None, DATAFORM=None, **kwargs): full citation for GIA model url: str url for GIA model reference - - References - ---------- - .. [A2013] G. A, J. Wahr, S. Zhong, - "Computations of the viscoelastic response of a 3-D - compressible Earth to surface loading: an application to - Glacial Isostatic Adjustment in Antarctica and Canada", - *Geophysical Journal International*, 192(2), 557-572 (2013). - `https://doi.org/10.1093/gji/ggs030 `_ - .. [Caron2018] L. Caron, E. R. Ivins, E. Larour, S. Adhikari, - J. Nilsson, and G. Blewitt, "GIA Model Statistics for GRACE Hydrology, - Cryosphere, and Ocean Science", *Geophysical Research Letters*, - 45(5), 2203-2212 (2018). - `https://doi.org/10.1002/2017GL076644 `_ - .. [Ivins2013] E. R. Ivins, T. S. James, J. Wahr, E. J. O. Schrama, - F. W. Landerer, and K. M. Simon, "Antarctic contribution to - sea level rise observed by GRACE with improved GIA correction", - *Journal of Geophysical Research: Solid Earth*, 118(6), 3126-3141 (2013). - `https://doi.org/10.1002/jgrb.50208 `_ - .. [Simpson2009] M. J. R. Simpson, L. Wake, G. A. Milne, and P. Huybrechts, - "The influence of decadal- to millennial-scale ice mass changes - on present-day vertical land motion in Greenland: Implications - for the interpretation of GPS observations", - *Journal of Geophysical Research: Solid Earth*, 116(B2), B02406 (2011). - `https://doi.org/10.1029/2010JB007776 `_ - .. [Peltier2015] W. R. Peltier, D. F. Argus, and R. Drummond, - "Space geodesy constrains ice age terminal deglaciation: - The global ICE-6G_C (VM5a) model", *Journal of Geophysical Research: - Solid Earth*, 120(1), 450-487 (2015). - `https://doi.org/10.1002/2014JB011176 `_ - .. [Peltier2018] W. R. Peltier, D. F. Argus, and R. Drummond, - "Comment on 'An Assessment of the ICE-6G_C (VM5a) Glacial - Isostatic Adjustment Model' by Purcell et al.", - *Journal of Geophysical Research: Solid Earth*, 123(2), 2019-2028 (2018). - `https://doi.org/10.1002/2016JB013844 `_ - .. [Whitehouse2012] P. L. Whitehouse, M. J. Bentley, G. A. Milne, - M. A. King, and I. D. Thomas, "A new glacial isostatic adjustment - model for Antarctica: calibrated and tested using observations of - relative sea-level change and present-day uplift rates", - *Geophysical Journal International*, 190(3), 1464-1482 (2012). - `https://doi.org/10.1111/j.1365-246X.2012.05557.x `_ - .. [Wu2010] X. Wu, M. B. Heflin, H. Schotman, B. L. A. Vermeersen, - D. Dong, R. S. Gross, E. R. Ivins, A. W. Moore, S. E. Owen, - "Simultaneous estimation of global present-day water transport and - glacial isostatic adjustment", *Nature Geoscience*, 3(9), 642-646 (2010). - `https://doi.org/10.1038/ngeo938 `_ """ # default keyword arguments kwargs.setdefault('LMAX', None) diff --git a/gravity_toolkit/read_GRACE_harmonics.py b/gravity_toolkit/read_GRACE_harmonics.py index 80f04155..4a628e84 100644 --- a/gravity_toolkit/read_GRACE_harmonics.py +++ b/gravity_toolkit/read_GRACE_harmonics.py @@ -89,7 +89,7 @@ def read_GRACE_harmonics(input_file, LMAX, **kwargs): MMAX: int or NoneType, default None Maximum order of spherical harmonics POLE_TIDE: bool, default False - Correct for pole tide drift following [Wahr2015]_ + Correct for pole tide drift following :cite:p:`Wahr:2015dg` Returns ------- @@ -113,14 +113,6 @@ def read_GRACE_harmonics(input_file, LMAX, **kwargs): sine spherical harmonic uncalibrated standard deviations header: str Header text from the GRACE/GRACE-FO file - - References - ---------- - .. [Wahr2015] J. Wahr, R. S. Nerem, and S. V. Bettadpur, "The pole tide - and its effect on GRACE time-variable gravity measurements: - Implications for estimates of surface mass variations". - *Journal of Geophysical Research: Solid Earth*, 120(6), 4597--4615, (2015). - `doi: 10.1002/2015JB011986 `_ """ # set default keyword arguments kwargs.setdefault('MMAX', None) diff --git a/gravity_toolkit/read_SLR_harmonics.py b/gravity_toolkit/read_SLR_harmonics.py index d21fa6bb..9d596fe2 100644 --- a/gravity_toolkit/read_SLR_harmonics.py +++ b/gravity_toolkit/read_SLR_harmonics.py @@ -99,7 +99,7 @@ def read_SLR_harmonics(SLR_file, **kwargs): def read_CSR_monthly_6x1(SLR_file, SCALE=1e-10, HEADER=True): """ Reads in monthly low degree and order spherical harmonic coefficients - from Satellite Laser Ranging (SLR) measurements + from Satellite Laser Ranging (SLR) measurements :cite:p:`Cheng:2011hh` Parameters ---------- @@ -124,13 +124,6 @@ def read_CSR_monthly_6x1(SLR_file, SCALE=1e-10, HEADER=True): output date as Modified Julian Day time: np.ndarray output date in year-decimal - - References - ---------- - .. [Cheng2010] M. Cheng, J. C. Ries, and B. D. Tapley, - "Variations of the Earth's figure axis from satellite laser ranging - and GRACE", *Journal of Geophysical Research*, 116(B01409), (2010). - `doi: 10.1029/2010JB000850 `_ """ # check that SLR file exists SLR_file = pathlib.Path(SLR_file).expanduser().absolute() @@ -250,6 +243,7 @@ def read_GSFC_weekly_6x1(SLR_file, SCALE=1.0, HEADER=True): r""" Reads weekly 5x5 spherical harmonic coefficients with 1 coefficient from degree 6 calculated from satellite laser ranging measurements + :cite:p:`Loomis:2019dc` :cite:p:`Loomis:2020bq` Parameters ---------- @@ -270,14 +264,6 @@ def read_GSFC_weekly_6x1(SLR_file, SCALE=1.0, HEADER=True): output date as Modified Julian Day time: np.ndarray output date in year-decimal - - References - ---------- - .. [Loomis2020] B. D. Loomis, K. E. Rachlin, D. N. Wiese, F. W. Landerer, - and S. B. Luthcke, "Replacing GRACE/GRACE-FO *C*\ :sub:`30` with - satellite laser ranging: Impacts on Antarctic Ice Sheet mass change". - *Geophysical Research Letters*, 47, (2020). - `doi: 10.1029/2019GL085488 `_ """ # check that SLR file exists SLR_file = pathlib.Path(SLR_file).expanduser().absolute() diff --git a/gravity_toolkit/read_gfc_harmonics.py b/gravity_toolkit/read_gfc_harmonics.py index 455f68e8..d3444887 100644 --- a/gravity_toolkit/read_gfc_harmonics.py +++ b/gravity_toolkit/read_gfc_harmonics.py @@ -88,7 +88,7 @@ def read_gfc_harmonics(input_file, TIDE=None, FLAG='gfc'): input_file: str full path to gfc spherical harmonic data file TIDE: string - Permanent tide system of output gravity fields [Losch2003]_ + Permanent tide system of output gravity fields :cite:p:`Losch:2003ve` - ``'tide_free'``: no permanent direct and indirect tidal potentials - ``'mean_tide'``: permanent tidal potentials (direct and indirect) @@ -134,14 +134,6 @@ def read_gfc_harmonics(input_file, TIDE=None, FLAG='gfc'): - ``'mean_tide'`` - ``'zero_tide'`` - ``'tide_free'`` - - Reference - --------- - .. [Losch2003] M. Losch and V. Seufer, - "How to Compute Geoid Undulations (Geoid Height Relative - to a Given Reference Ellipsoid) from Spherical Harmonic - Coefficients for Satellite Altimetry Applications", (2003). - `eprint ID: 11802 `_ """ # full path to input filename input_file = pathlib.Path(input_file).expanduser().absolute() diff --git a/gravity_toolkit/read_love_numbers.py b/gravity_toolkit/read_love_numbers.py index e018d0b0..f1b2f44e 100755 --- a/gravity_toolkit/read_love_numbers.py +++ b/gravity_toolkit/read_love_numbers.py @@ -103,7 +103,8 @@ def read_love_numbers(love_numbers_file, LMAX=None, HEADER=2, COLUMNS=['l','hl','kl','ll'], REFERENCE='CE', FORMAT='tuple'): """ Reads PREM load Love/Shida numbers file and applies isomorphic - parameters [Dziewonski1981]_ [Blewett2003]_ + parameters :cite:p:`Dziewonski:1981bz` :cite:p:`Blewitt:2003bz` + :cite:p:`Wahr:1998hy` Parameters ---------- @@ -144,40 +145,6 @@ def read_love_numbers(love_numbers_file, LMAX=None, HEADER=2, Love number of Gravitational Potential ll: np.ndarray Love (Shida) number of Horizontal Displacement - - References - ---------- - .. [Blewett2003] G. Blewitt, "Self-consistency in reference frames, geocenter - definition, and surface loading of the solid Earth", - *Journal of Geophysical Research: Solid Earth*, 108(B2), 2103, (2003). - `doi: 10.1029/2002JB002082 `_ - - .. [Dziewonski1981] A. M. Dziewonski and D. L. Anderson, - "Preliminary reference Earth model", - *Physics of the Earth and Planetary Interiors*, 25(4), 297--356, (1981). - `doi: 10.1016/0031-9201(81)90046-7 `_ - - .. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, - "Practical numerical computation of love numbers and applications", - Workshop of the COST Action ES0701, (2010). - `doi: 10.13140/RG.2.1.1866.7045 `_ - - .. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a - realistically stratified earth, and a further analysis of postglacial - rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). - `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - - .. [Wahr1998] J. Wahr, M. Molenaar, and F. Bryan, - "Time variability of the Earth's gravity field: Hydrological and - oceanic effects and their possible detection using GRACE", - *Journal of Geophysical Research*, 103(B12), 30205--30229, (1998). - `doi: 10.1029/98JB02844 `_ - - .. [Wang2012] H. Wang et al., "Load Love numbers and Green's - functions for elastic Earth models PREM, iasp91, ak135, and - modified models with refined crustal structure from Crust 2.0", - *Computers & Geosciences*, 49, 190--199, (2012). - `doi: 10.1016/j.cageo.2012.06.022 `_ """ # Input load Love/Shida number data file and read contents file_contents = extract_love_numbers(love_numbers_file) @@ -335,7 +302,7 @@ def load_love_numbers(LMAX, LOVE_NUMBERS=0, REFERENCE='CF', FORMAT='tuple'): """ Wrapper function for reading PREM load Love/Shida numbers for a range of spherical harmonic degrees and applying - isomorphic parameters [Blewett2003]_ + isomorphic parameters :cite:p:`Blewitt:2003bz` Parameters ---------- @@ -344,13 +311,13 @@ def load_love_numbers(LMAX, LOVE_NUMBERS=0, REFERENCE='CF', FORMAT='tuple'): LOVE_NUMBERS: int, default 0 Treatment of the Load Love/Shida numbers - - ``0``: [Han1995]_ values from PREM - - ``1``: [Gegout2010]_ values from PREM - - ``2``: [Wang2012]_ values from PREM - - ``3``: [Wang2012]_ values from PREM with hard sediment - - ``4``: [Wang2012]_ values from PREM with soft sediment + - ``0``: :cite:p:`Han:1995go` values from PREM + - ``1``: :cite:p:`Gegout:2010gc` values from PREM + - ``2``: :cite:p:`Wang:2012gc` values from PREM + - ``3``: :cite:p:`Wang:2012gc` values from PREM with hard sediment + - ``4``: :cite:p:`Wang:2012gc` values from PREM with soft sediment REFERENCE: str - Reference frame for calculating degree 1 Love/Shida numbers [Blewett2003]_ + Reference frame for calculating degree 1 Love/Shida numbers :cite:p:`Blewitt:2003bz` - ``'CF'``: Center of Surface Figure (default) - ``'CM'``: Center of Mass of Earth System @@ -371,29 +338,6 @@ def load_love_numbers(LMAX, LOVE_NUMBERS=0, REFERENCE='CF', FORMAT='tuple'): Love number of Gravitational Potential ll: np.ndarray Love (Shida) number of Horizontal Displacement - - References - ---------- - .. [Blewett2003] G. Blewitt, "Self-consistency in reference frames, geocenter - definition, and surface loading of the solid Earth", - *Journal of Geophysical Research: Solid Earth*, 108(B2), 2103, (2003). - `doi: 10.1029/2002JB002082 `_ - - .. [Gegout2010] P. Gegout, J. Boehm, and D. Wijaya, - "Practical numerical computation of love numbers and applications", - Workshop of the COST Action ES0701, (2010). - `doi: 10.13140/RG.2.1.1866.7045 `_ - - .. [Han1995] D. Han and J. Wahr, "The viscoelastic relaxation of a - realistically stratified earth, and a further analysis of postglacial - rebound", *Geophysical Journal International*, 120(2), 287--311, (1995). - `doi: 10.1111/j.1365-246X.1995.tb01819.x `_ - - .. [Wang2012] H. Wang et al., "Load Love numbers and Green's - functions for elastic Earth models PREM, iasp91, ak135, and - modified models with refined crustal structure from Crust 2.0", - *Computers & Geosciences*, 49, 190--199, (2012). - `doi: 10.1016/j.cageo.2012.06.022 `_ """ # load Love/Shida numbers file if (LOVE_NUMBERS == 0): @@ -554,7 +498,7 @@ def transform(self, reference): """ Calculate and apply calculate isomorphic parameters to transform from the Center of Mass of the Solid Earth - Reference Frame [Blewett2003]_ + Reference Frame :cite:p:`Blewitt:2003bz` Parameters ---------- @@ -566,13 +510,6 @@ def transform(self, reference): - ``'CH'``: Center of Surface Height Figure - ``'CM'``: Center of Mass of Earth System - ``'CE'``: Center of Mass of Solid Earth - - References - ---------- - .. [Blewett2003] G. Blewitt, "Self-consistency in reference frames, geocenter - definition, and surface loading of the solid Earth", - *Journal of Geophysical Research: Solid Earth*, 108(B2), 2103, (2003). - `doi: 10.1029/2002JB002082 `_ """ # calculate isomorphic parameters for different reference frames # From Blewitt (2003), Wahr (1998), Trupin (1992) and Farrell (1972) diff --git a/gravity_toolkit/sea_level_equation.py b/gravity_toolkit/sea_level_equation.py index 23e07e3d..712853f9 100644 --- a/gravity_toolkit/sea_level_equation.py +++ b/gravity_toolkit/sea_level_equation.py @@ -132,10 +132,11 @@ def sea_level_equation(loadClm, loadSlm, glon, glat, land_function, LMAX=0, PLM=None, FILL_VALUE=0, ASTYPE=np.longdouble, SCALE=1e-280, **kwargs): """ Solves the sea level equation with the option of including - polar motion feedback [Farrell1976]_ [Kendall2005]_ [Mitrovica2003]_ + polar motion feedback :cite:p:`Farrell:1976hm` :cite:p:`Kendall:2005ds` + :cite:p:`Mitrovica:2003cq` Uses a Clenshaw summation to calculate the spherical harmonic - summation [Holmes2002]_ [Tscherning1982]_ + summation :cite:p:`Holmes:2002ff` :cite:p:`Tscherning:1982tu` Parameters ---------- @@ -156,16 +157,16 @@ def sea_level_equation(loadClm, loadSlm, glon, glat, land_function, LMAX=0, BODY_TIDE_LOVE: int, default 0 Treatment of the body tide Love number - - ``0``: [Wahr1981]_ and [Wahr1985]_ values from PREM - - ``1``: [Farrell1972]_ values from Gutenberg-Bullen oceanic mantle model + - ``0``: :cite:p:`Wahr:1981ea` and :cite:p:`Wahr:1985gr` values from PREM + - ``1``: :cite:p:`Farrell:1972cm` values from Gutenberg-Bullen oceanic mantle model - list or tuple: custom values ``(k2b,h2b)`` FLUID_LOVE: int, default 0 Treatment of the fluid Love number - - ``0``: [Han1989] fluid love number - - ``1``: [Munk1960]_ secular love number - - ``2``: [Munk1960]_ fluid love number - - ``3``: [Lambeck1980] fluid love number + - ``0``: :cite:p:`Han:1989kj` fluid love number + - ``1``: :cite:p:`Munk:1960uk` secular love number + - ``2``: :cite:p:`Munk:1960uk` fluid love number + - ``3``: :cite:p:`Lambeck:1980um` fluid love number - list or tuple: custom value ``(klf)`` POLAR: bool, default True Include polar feedback @@ -184,46 +185,6 @@ def sea_level_equation(loadClm, loadSlm, glon, glat, land_function, LMAX=0, ------- sea_level: np.ndarray spatial field calculated using sea level solver - - References - ---------- - .. [Farrell1972] W. E. Farrell, "Deformation of the Earth by surface loads", - *Reviews of Geophysics*, 10(3), 761--797, (1972). - `doi: 10.1029/RG010i003p00761 `_ - .. [Farrell1976] W. E. Farrell and J. A. Clark, "On Postglacial Sea Level", - *Geophysical Journal of the Royal Astronomical Society*, 46(3), 647--667, - (1976). `doi: 10.1111/j.1365-246X.1976.tb01252.x `_ - .. [Han1989] D. Han and J. Wahr, "Post-Glacial Rebound Analysis for a - Rotating Earth", *Slow Deformation and Transmission of Stress in the Earth*, - 49, (1989). `doi: 10.1029/GM049p0001 `_ - .. [Holmes2002] S. A. Holmes and W. E. Featherstone, "A unified approach - to the Clenshaw summation and the recursive computation of very high - degree and order normalised associated Legendre functions", - *Journal of Geodesy*, 76, 279--299, (2002). - `doi: 10.1007/s00190-002-0216-2 `_ - .. [Kendall2005] R. A. Kendall, J. X. Mitrovica, and G. A. Milne, - "On post-glacial sea level -- II. Numerical formulation and comparative - results on spherically symmetric models", *Geophysical Journal International*, - 161(3), 679--706, (2005). - `doi: 10.1111/j.1365-246X.2005.02553.x `_ - .. [Lambeck1980] K. Lambeck, *The Earth's Variable Rotation: - Geophysical Causes and Consequences*, First Edition, (1980). - .. [Mitrovica2003] J. X. Mitrovica and G. A. Milne, - "On post-glacial sea level: I. General theory", - *Geophysical Journal International*, 154(2), 253--267, (2003). - `doi: 10.1046/j.1365-246X.2003.01942.x `_ - .. [Munk1960] W. H. Munk and G. J. F. MacDonald, - *The Rotation of the Earth: A Geophysical Discussion*, First Edition, (1960). - .. [Tscherning1982] C. C. Tscherning and K. Poder, - "Some Geodetic Applications of Clenshaw Summation", - *Bollettino di Geodesia e Scienze*, 4, 349--375, (1982). - .. [Wahr1981] J. M. Wahr, "Body tides on an elliptical, rotating, - elastic and oceanless Earth", *Geophysical Journal of the Royal - Astronomical Society*, 64(3), 677--703, (1981). - `doi: 10.1111/j.1365-246X.1981.tb02690.x `_ - .. [Wahr1985] J. M. Wahr, "Deformation induced by polar motion", - *Journal of Geophysical Research: Solid Earth*, 90(B11), 9363--9368, - (1985). `doi: 10.1029/JB090iB11p09363 `_ """ # dimensions of land function diff --git a/gravity_toolkit/spatial.py b/gravity_toolkit/spatial.py index f62f0459..255b57e8 100644 --- a/gravity_toolkit/spatial.py +++ b/gravity_toolkit/spatial.py @@ -1943,7 +1943,7 @@ def kfactor(self, var): """ Calculate the scaling factor and scaling factor errors from two ``spatial`` or ``scaling_factors`` objects - following [Landerer2012]_ and [Hsu2017]_ + following :cite:p:`Landerer:2012kf` and :cite:p:`Hsu:2017hd` Parameters ---------- @@ -1954,17 +1954,6 @@ def kfactor(self, var): ------- temp: obj scaling factor, scaling error and magnitude - - References - ---------- - .. [Landerer2012] F. W. Landerer and S. C. Swenson, - "Accuracy of scaled GRACE terrestrial water storage estimates", - *Water Resources Research*, 48(W04531), (2012). - `doi: 10.1029/2011WR011453 `_ - .. [Hsu2017] C.-W. Hsu and I. Velicogna, "Detection of Sea Level - Fingerprints derived from GRACE gravity data", - *Geophysical Research Letters*, 44, 8953--8961, (2017). - `doi: 10.1002/2017GL074070 `_ """ # copy to not modify original inputs temp1 = self.copy() diff --git a/gravity_toolkit/time.py b/gravity_toolkit/time.py index e28abba0..8ad52ced 100644 --- a/gravity_toolkit/time.py +++ b/gravity_toolkit/time.py @@ -600,7 +600,7 @@ def convert_calendar_decimal(year, month, day=None, hour=None, minute=None, second=None, DofY=None): """ Converts from calendar date into decimal years taking into - account leap years + account leap years :cite:p:`Dershowitz:2007cc` Parameters ---------- @@ -623,12 +623,6 @@ def convert_calendar_decimal(year, month, day=None, hour=None, minute=None, ------- t_date: np.ndarray date in decimal-year format - - References - ---------- - .. [Dershowitz2008] Dershowitz, N. and E.M. Reingold. - *Calendrical Calculations*, (2008). - Cambridge: Cambridge University Press. """ # number of dates @@ -748,6 +742,7 @@ def convert_calendar_decimal(year, month, day=None, hour=None, minute=None, def convert_julian(JD, **kwargs): """ Converts from Julian day to calendar date and time + :cite:p:`Press:1988we`, :cite:p:`Hatcher:1984uo` Parameters ---------- @@ -776,15 +771,6 @@ def convert_julian(JD, **kwargs): minute of the hour second: np.ndarray second of the minute - - References - ---------- - .. [Press1988] *Numerical Recipes in C*, William H. Press, - Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling. - Second Edition, Cambridge University Press, (1988). - .. [Hatcher1984] Hatcher, D. A., "Simple Formulae for Julian Day Numbers and - Calendar Dates", *Quarterly Journal of the Royal Astronomical - Society*, 25(1), (1984). """ # set default keyword arguments kwargs.setdefault('astype', None) diff --git a/gravity_toolkit/time_series/lomb_scargle.py b/gravity_toolkit/time_series/lomb_scargle.py index 9a00e6cc..f24c3326 100755 --- a/gravity_toolkit/time_series/lomb_scargle.py +++ b/gravity_toolkit/time_series/lomb_scargle.py @@ -59,8 +59,8 @@ def lomb_scargle(t_in, d_in, **kwargs): """ Computes periodograms for least-squares spectral analysis following - [Lomb1976]_ [Scargle1982]_ and computes the frequency probabilities - following [Horne1986]_ + :cite:p:`Lomb:1976bo` :cite:p:`Scargle:1982eu` and computes the + frequency probabilities following :cite:p:`Horne:1986ds` Parameters ---------- @@ -95,22 +95,6 @@ def lomb_scargle(t_in, d_in, **kwargs): period at peak power density centroid: float centroid of power density and period - - References - ---------- - .. [Lomb1976] N. R. Lomb, "Least-squares frequency analysis of - unequally spaced data", *Astrophysics and Space Science*, - 39, 447--462, 1976. `doi: 10.1007/BF00648343 - `_ - .. [Scargle1982] J. D. Scargle, "Studies in astronomical time series - analysis. II - Statistical aspects of spectral analysis of - unevenly spaced data", *The Astrophysical Journal*, - 263, 835--853, 1982. `doi: 10.1086/160554 - `_ - .. [Horne1986] J. H. Horne and S. L. Baliunas, "A Prescription for - Period Analysis of Unevenly Sampled Time Series", - *The Astrophysical Journal*, 302, 757--763, 1986. - `doi: 10.1086/164037 `_ """ # default keyword arguments kwargs.setdefault('NORMALIZE', False) diff --git a/gravity_toolkit/time_series/piecewise.py b/gravity_toolkit/time_series/piecewise.py index 4e4c2390..e2349007 100755 --- a/gravity_toolkit/time_series/piecewise.py +++ b/gravity_toolkit/time_series/piecewise.py @@ -101,7 +101,7 @@ def piecewise(t_in, d_in, BREAK_TIME=None, BREAKPOINT=None, STDEV=0, CONF=0, AICc=False): r""" Fits a synthetic signal to data over a time period by ordinary or - weighted least-squares for breakpoint analysis [Toms2003]_ + weighted least-squares for breakpoint analysis :cite:p:`Toms:2003gv` Parameters ---------- @@ -129,7 +129,7 @@ def piecewise(t_in, d_in, BREAK_TIME=None, BREAKPOINT=None, CONF: float, default 0 Confidence interval of output error AICc: bool, default False - Use second order AIC for small sample sizes [Burnham2002]_ + Use second order AIC for small sample sizes :cite:p:`Burnham:2002ms` Returns ------- @@ -168,17 +168,6 @@ def piecewise(t_in, d_in, BREAK_TIME=None, BREAKPOINT=None, number of terms used in fit cov_mat: float covariance matrix - - References - ---------- - .. [Toms2003] J. D. Toms and M. L. Lesperance, - "Piecewise Regression: A Tool For Identifying Ecological - Thresholds", *Ecology*, 84, 2034-2041, (2003). - `doi: 10.1890/02-0472 `_ - .. [Burnham2002] K. P. Burnham and D. R. Anderson, - *Model Selection and Multimodel Inference*, - 2nd Edition, 488 pp., (2002). - `doi: 10.1007/b97636 `_ """ t_in = np.squeeze(t_in) diff --git a/gravity_toolkit/time_series/regress.py b/gravity_toolkit/time_series/regress.py index 3795dba0..bca9ecd4 100755 --- a/gravity_toolkit/time_series/regress.py +++ b/gravity_toolkit/time_series/regress.py @@ -146,7 +146,7 @@ def regress(t_in, d_in, ORDER=1, CYCLES=[0.5,1.0], TERMS=[], CONF: float, default 0 Confidence interval of output error AICc: bool, default False - Use second order AIC for small sample sizes [Burnham2002]_ + Use second order AIC for small sample sizes :cite:p:`Burnham:2002ms` Returns ------- @@ -185,13 +185,6 @@ def regress(t_in, d_in, ORDER=1, CYCLES=[0.5,1.0], TERMS=[], number of terms used in fit cov_mat: float covariance matrix - - Reference - --------- - .. [Burnham2002] K. P. Burnham and D. R. Anderson, - *Model Selection and Multimodel Inference*, - 2nd Edition, 488 pp., (2002). - `doi: 10.1007/b97636 `_ """ # remove singleton dimensions diff --git a/gravity_toolkit/time_series/savitzky_golay.py b/gravity_toolkit/time_series/savitzky_golay.py index 10fa3f44..a95e4a09 100644 --- a/gravity_toolkit/time_series/savitzky_golay.py +++ b/gravity_toolkit/time_series/savitzky_golay.py @@ -66,7 +66,7 @@ def savitzky_golay(t_in, y_in, WINDOW=None, ORDER=2, DERIV=0, RATE=1, DATA_ERR=0): """ Smooth and optionally differentiate data with a Savitzky-Golay - filter [Savitzky1964]_ [Press2007]_ + filter :cite:p:`Savitzky:1964bn` :cite:p:`Press:1988we` Parameters ---------- @@ -97,15 +97,6 @@ def savitzky_golay(t_in, y_in, WINDOW=None, ORDER=2, DERIV=0, Estimated error at time points time: float Time points for window - - References - ---------- - .. [Savitzky1964] A. Savitzky, M. J. E. Golay, "Smoothing and - Differentiation of Data by Simplified Least Squares Procedures". - *Analytical Chemistry*, 36(8), 1627--1639, (1964). - .. [Press2007] *Numerical Recipes 3rd Edition: The Art of Scientific - Computing*, W.H. Press, S.A. Teukolsky, W. T. Vetterling, - B.P. Flannery. Cambridge University Press, (2007). """ # verify that WINDOW is positive, odd and greater than ORDER+1 diff --git a/gravity_toolkit/time_series/smooth.py b/gravity_toolkit/time_series/smooth.py index 5b2d65e5..247e934c 100755 --- a/gravity_toolkit/time_series/smooth.py +++ b/gravity_toolkit/time_series/smooth.py @@ -87,7 +87,7 @@ def smooth(t_in, d_in, HFWTH=6, MOVING=False, DATA_ERR=0, WEIGHT=0, Computes the moving average of a time-series 1) centered moving average - 2) 13-month Loess filter [Velicogna2009]_ + 2) 13-month Loess filter :cite:p:`Velicogna:2009ft` 3) 13-month Loess filter weighted and outputs for all dates Parameters @@ -133,13 +133,6 @@ def smooth(t_in, d_in, HFWTH=6, MOVING=False, DATA_ERR=0, WEIGHT=0, noise component after removing the Loess trend and seasonal components reduce: float original time series after removing start and end half-windows - - References - ---------- - .. [Velicogna2009] I. Velicogna, "Increasing rates of ice mass loss - from the Greenland and Antarctic ice sheets revealed by GRACE", - *Geophysical Research Letters*, 36(L19503), - `doi: 10.1029/2009GL040222 `_ """ # remove singleton dimensions diff --git a/gravity_toolkit/tools.py b/gravity_toolkit/tools.py index 27bc8a79..36c93f0e 100644 --- a/gravity_toolkit/tools.py +++ b/gravity_toolkit/tools.py @@ -292,9 +292,9 @@ def select_options(self, **kwargs): C50: obj Dropdown menu widget for setting *C*\ :sub:`50` data product pole_tide: obj - Checkbox widget for correcting for Pole Tide Drift [Wahr2015]_ + Checkbox widget for correcting for Pole Tide Drift :cite:p:`Wahr:2015dg` atm: obj - Checkbox widget for correcting ECMWF Atmospheric Jumps [Fagiolini2015]_ + Checkbox widget for correcting ECMWF Atmospheric Jumps :cite:p:`Fagiolini:2015kc` """ # set default keyword arguments @@ -490,7 +490,7 @@ def select_corrections(self, **kwargs): gaussian: obj Text entry widget for setting Gaussian Smoothing Radius in kilometers destripe: obj - Checkbox widget for destriping spherical harmonics [Swenson2006]_ + Checkbox widget for destriping spherical harmonics :cite:p:`Swenson:2006hu` spacing: obj Text entry widget for setting output spatial degree spacing interval: obj @@ -1041,9 +1041,9 @@ def custom_colormap(N, map_name, **kwargs): map_name: str name of color map - - ``'Joughin'``: [Joughin2018]_ standard velocity colormap - - ``'Rignot'``: [Rignot2011]_ standard velocity colormap - - ``'Seroussi'``: [Seroussi2011]_ velocity divergence colormap + - ``'Joughin'``: :cite:p:`Joughin:2018ei` standard velocity colormap + - ``'Rignot'``: :cite:p:`Rignot:2011ko` standard velocity colormap + - ``'Seroussi'``: :cite:p:`Seroussi:2011hi` velocity divergence colormap **kwargs: dict optional arguments for LinearSegmentedColormap """ diff --git a/gravity_toolkit/units.py b/gravity_toolkit/units.py index af1ac59a..6fb20109 100644 --- a/gravity_toolkit/units.py +++ b/gravity_toolkit/units.py @@ -120,7 +120,7 @@ def mass(self) -> float: def harmonic(self, hl, kl, ll, **kwargs): """ Calculates degree dependent factors for converting spherical - harmonic units from [Wahr1998]_ + harmonic units from :cite:p:`Wahr:1998hy` Parameters ---------- @@ -150,9 +150,9 @@ def harmonic(self, hl, kl, ll, **kwargs): mmCH: float millimeters elastic crustal deformation (horizontal) cmVCU: float - centimeters viscoelastic crustal uplift from [Wahr2000]_ + centimeters viscoelastic crustal uplift from :cite:p:`Wahr:2000ek` mVCU: float - meters viscoelastic crustal uplift from [Wahr2000]_ + meters viscoelastic crustal uplift from :cite:p:`Wahr:2000ek` microGal: float microGal gravity perturbations mbar: float @@ -199,7 +199,7 @@ def harmonic(self, hl, kl, ll, **kwargs): def spatial(self, hl, kl, ll, **kwargs): """ Calculates degree dependent factors for converting spatial units - from [Wahr1998]_ + from :cite:p:`Wahr:1998hy` Parameters ---------- diff --git a/gravity_toolkit/utilities.py b/gravity_toolkit/utilities.py index 28d3b38a..4c8c0460 100644 --- a/gravity_toolkit/utilities.py +++ b/gravity_toolkit/utilities.py @@ -2134,7 +2134,7 @@ def from_figshare( mode: oct = 0o775 ): """ - Download [Sutterley2019]_ geocenter files from + Download :cite:p:`Sutterley:2019bx` geocenter files from `figshare `_ Parameters @@ -2157,13 +2157,6 @@ def from_figshare( regular expression pattern for reducing list mode: oct, default 0o775 permissions mode of output local file - - References - ---------- - .. [Sutterley2019] T. C. Sutterley and I. Velicogna, - "Improved Estimates of Geocenter Variability from Time-Variable Gravity - and Ocean Model Outputs", *Remote Sensing*, 11(18), 2108, (2019). - `doi: 10.3390/rs11182108 `_ """ # figshare host HOST=['https://api.figshare.com','v2','articles',article] diff --git a/scripts/calc_mascon.py b/scripts/calc_mascon.py index 96825075..48f7dd7e 100644 --- a/scripts/calc_mascon.py +++ b/scripts/calc_mascon.py @@ -315,7 +315,8 @@ def calc_mascon(base_dir, PROC, DREL, DSET, LMAX, RAD, base_dir = pathlib.Path(base_dir).expanduser().absolute() # recursively create output directory if not currently existing OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # list object of output files for file logs (full path) output_files = [] diff --git a/scripts/calc_sensitivity_kernel.py b/scripts/calc_sensitivity_kernel.py index 98318782..f3563e2f 100644 --- a/scripts/calc_sensitivity_kernel.py +++ b/scripts/calc_sensitivity_kernel.py @@ -197,7 +197,8 @@ def calc_sensitivity_kernel(LMAX, RAD, # recursively create output directory if not currently existing OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # list object of output files for file logs (full path) output_files = [] diff --git a/scripts/dealiasing_global_uplift.py b/scripts/dealiasing_global_uplift.py index 980ff4ec..fd6fa239 100644 --- a/scripts/dealiasing_global_uplift.py +++ b/scripts/dealiasing_global_uplift.py @@ -115,7 +115,8 @@ def dealiasing_global_uplift(base_dir, grace_dir = base_dir.joinpath('AOD1B', DREL) # output directory setup OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # list object of output files for file logs (full path) output_files = [] diff --git a/scripts/grace_raster_grids.py b/scripts/grace_raster_grids.py index 09dcc2a7..af4db8ec 100644 --- a/scripts/grace_raster_grids.py +++ b/scripts/grace_raster_grids.py @@ -237,7 +237,8 @@ def grace_raster_grids(base_dir, PROC, DREL, DSET, LMAX, RAD, # recursively create output directory if not currently existing OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # output attributes for raster files attributes = dict(ROOT=collections.OrderedDict()) diff --git a/scripts/grace_spatial_error.py b/scripts/grace_spatial_error.py index 89beb622..f20672b5 100755 --- a/scripts/grace_spatial_error.py +++ b/scripts/grace_spatial_error.py @@ -221,7 +221,8 @@ def grace_spatial_error(base_dir, PROC, DREL, DSET, LMAX, RAD, # recursively create output directory if not currently existing OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # output attributes for spatial files attributes = collections.OrderedDict() diff --git a/scripts/grace_spatial_maps.py b/scripts/grace_spatial_maps.py index 6a814f21..ea65903a 100755 --- a/scripts/grace_spatial_maps.py +++ b/scripts/grace_spatial_maps.py @@ -248,7 +248,8 @@ def grace_spatial_maps(base_dir, PROC, DREL, DSET, LMAX, RAD, # recursively create output directory if not currently existing OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # output attributes for spatial files attributes = collections.OrderedDict() diff --git a/scripts/mascon_reconstruct.py b/scripts/mascon_reconstruct.py index 5b49d412..78ab5500 100644 --- a/scripts/mascon_reconstruct.py +++ b/scripts/mascon_reconstruct.py @@ -156,7 +156,8 @@ def mascon_reconstruct(DSET, LMAX, RAD, # create output directory if currently non-existent OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # for datasets not GSM: will add a label for the dataset dset_str = '' if (DSET == 'GSM') else f'_{DSET}' diff --git a/scripts/piecewise_grace_maps.py b/scripts/piecewise_grace_maps.py index a9c98a27..f936dc1f 100755 --- a/scripts/piecewise_grace_maps.py +++ b/scripts/piecewise_grace_maps.py @@ -139,7 +139,8 @@ def piecewise_grace_maps(LMAX, RAD, # create output directory if currently non-existent OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # output filename suffix suffix = dict(ascii='txt', netCDF4='nc', HDF5='H5')[DATAFORM] diff --git a/scripts/regress_grace_maps.py b/scripts/regress_grace_maps.py index 69913a86..62be313b 100755 --- a/scripts/regress_grace_maps.py +++ b/scripts/regress_grace_maps.py @@ -138,7 +138,8 @@ def regress_grace_maps(LMAX, RAD, # create output directory if currently non-existent OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # output filename suffix suffix = dict(ascii='txt', netCDF4='nc', HDF5='H5')[DATAFORM] diff --git a/scripts/scale_grace_maps.py b/scripts/scale_grace_maps.py index 10fa58ab..3f29117e 100644 --- a/scripts/scale_grace_maps.py +++ b/scripts/scale_grace_maps.py @@ -246,7 +246,8 @@ def scale_grace_maps(base_dir, PROC, DREL, DSET, LMAX, RAD, # recursively create output Directory if not currently existing OUTPUT_DIRECTORY = pathlib.Path(OUTPUT_DIRECTORY).expanduser().absolute() - OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) + if not OUTPUT_DIRECTORY.exists(): + OUTPUT_DIRECTORY.mkdir(mode=MODE, parents=True, exist_ok=True) # list object of output files for file logs (full path) output_files = []