def WDMAM2_800(lmax=800):
'''
WDMAM2_800 is a degree 800 model of the Earth's lithospheric magnetic field
that is based on a worldwide compilation of near-surface magnetic data.
This is the second version of the World Digital Magnetic Anomaly Map
(WDMAM).
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Lesur, V., Hamoudi, M., Choi, Y., Dyment, J., Thébault, E. (2016). Building
the second version of the world digital magnetic anomaly map (WDMAM).
Earth, Planets and Space, 68, 27, doi:10.1186/s40623-016-0404-6.
'''
fname = _retrieve(
url="https://zenodo.org/record/3902903/files/WDMAM2_800.sh.gz?download=1", # noqa: E501
known_hash="sha256:3ddf3d9f37cbfafebf965649c5d3745c52a5127b4c4cd7c2768ad521867e1e2d", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHMagCoeffs.from_file(fname, r0=6371.2e3, lmax=lmax, header=False,
file_units='nT', units='nT')
def Morschhauser2014(lmax=110):
'''
Morschhauser2014 is a 110 degree and order spherical harmonic model of the
magnetic potential of Mars. The coefficients are output in units of nT.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
References
----------
Morschhauser, A., Lesur, V., Grott, M. (2014). A spherical harmonic model
of the lithospheric magnetic field of Mars, Journal of Geophysical
Research: Planets, 119, 1162-1188, doi:10.1002/2013JE004555.
'''
fname = _retrieve(
url=
"https://zenodo.org/record/3876495/files/Morschhauser2014.txt.gz?download=1", # noqa: E501
known_hash=
"sha256:a86200b3147a24447ff8bba88ec6047329823275813a9f5e9505bb611e3e86e0", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
processor=_Decompress(),
)
return _SHMagCoeffs.from_file(fname,
r0=3393.5e3,
skip=3,
header=False,
format='dov',
file_units='nT',
name='Morschhauser2014',
units='nT')
def GMM3(lmax=120):
'''
GMM3 is a GSFC 120 degree and order spherical harmonic model of the
gravitational potential of Mars. This model applies a Kaula constraint for
degrees greater than 90.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Genova, A., Goossens, S., Lemoine, F.G., Mazarico, E., Neumann, G.A.,
Smith, D.E., Zuber, M.T. (2016). Seasonal and static gravity field of
Mars from MGS, Mars Odyssey and MRO radio science, Icarus, 272,
228-245, doi:10.1016/j.icarus.2016.02.050.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/mro/mro-m-rss-5-sdp-v1/mrors_1xxx/data/shadr/gmm3_120_sha.tab", # noqa: E501
known_hash=
"sha256:eb4913b1afb6682406e6a9dad5be7918a162fa8462473c9a2e7aae258d4c2c9c", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='km',
r0_index=0,
gm_index=1,
errors=True,
omega=_omega.value,
name='GMM3')
def bedrock(lmax=2160):
'''
Earth's bedrock: Harmonic model of the surface relief, excluding water
and ice masses.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Hirt, C., Rexer, M. (2015). Earth2014: 1 arc-min shape, topography, bedrock
and ice-sheet models - available as gridded data and degree-10,800
spherical harmonics, International Journal of Applied Earth Observation
and Geoinformation, 39, 103-112, doi:10.10.1016/j.jag.2015.03.001.
'''
fname = _retrieve(
url=
"http://ddfe.curtin.edu.au/gravitymodels/Earth2014/data_5min/shcs_to2160/Earth2014.BED2014.degree2160.bshc", # noqa: E501
known_hash=
"sha256:146dcc80f17d201352d391aa90f487f5ed16006a6a3966add2d023b998727af7", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHCoeffs.from_file(fname, lmax=lmax, format='bshc', units='m')
def MRO120D(lmax=120):
'''
MRO120D is a JPL 120 degree and order spherical harmonic model of the
gravitational potential of Mars. This model applies a Kaula constraint for
degrees greater than 80.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Konopliv, A.S., Park, R.S., Folkner, W.M. (2016). An improved JPL Mars
gravity field and orientation from Mars orbiter and lander tracking
data. Icarus, 274, 253-260, doi:10.1016/j.icarus.2016.02.052.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/mro/mro-m-rss-5-sdp-v1/mrors_1xxx/data/shadr/jgmro_120d_sha.tab", # noqa: E501
known_hash=
"sha256:00c3a2fada7bdfb8022962752b1226be1de21ea469f9e88af5d8dc47d23883bd", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='km',
r0_index=0,
gm_index=1,
errors=True,
omega=_omega.value,
name='MRO120D')
def JGMESS160A_ACCEL(lmax=160):
'''
JGMESS160A_ACCEL is a JPL 160 degree and order spherical harmonic model of
the gravitational potential of Mercury. This model applies a surface
acceleration constraint that is based on the degree strength given by the
coefficient covariance.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Konopliv, A.S., Park, R.S., Ermakov, A.I. (2020). The Mercury gravity
field, orientation, Love number, and ephemeris from the MESSENGER
radiometric tracking data, Icarus, 335, 253-260,
doi:10.1016/j.icarus.2019.07.020.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/messenger/mess-h-rss_mla-5-sdp-v1/messrs_1001/data/shadr/jgmess_160a_accel_sha.tab", # noqa: E501
known_hash=
"sha256:a0f99553fcea3d7d0c1395c89d8516f4e53e9e39893a2b82541ca1520b291423", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='km',
errors=True,
omega=_omega.value)
def ice(lmax=2160):
'''
Thickness of Earth's ice sheets: Harmonic model of the thickness of
Earth's ice masses.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Hirt, C., Rexer, M. (2015). Earth2014: 1 arc-min shape, topography, bedrock
and ice-sheet models - available as gridded data and degree-10,800
spherical harmonics, International Journal of Applied Earth Observation
and Geoinformation, 39, 103-112, doi:10.10.1016/j.jag.2015.03.001.
'''
fname = _retrieve(
url=
"http://ddfe.curtin.edu.au/gravitymodels/Earth2014/data_5min/shcs_to2160/Earth2014.ICE2014.degree2160.bshc", # noqa: E501
known_hash=
"sha256:04cd185cc668eba6f9bd1db527c4985703cce8d1a9fb993509e625e2bbecc78e", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHCoeffs.from_file(fname, lmax=lmax, format='bshc', units='m')
def CERES18D(lmax=18):
'''
CERES18D is a JPL 18 degree and order spherical harmonic model of the
gravitational potential of (1) Ceres.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Konopliv, A.S., Park, R.S., Vaughan, A.T., Bills, B.G., Asmar, S.W.,
Ermakov, A.I., Rambaux, N., Raymond, C.A., Castillo-Rogez, J.C.,
Russell, C.T., Smith, D.E., Zuber, M.T. (2018). The Ceres gravity
field, spin pole, rotation period and orbit from the Dawn radiometric
tracking and optical data, Icarus, 299, 411-429,
doi:10.1016/j.icarus.2017.08.005.
'''
fname = _retrieve(
url="https://sbnarchive.psi.edu/pds3/dawn/grav/DWNCGRS_2_v3_181005/DATA/SHADR/JGDWN_CER18D_SHA.TAB", # noqa: E501
known_hash="sha256:e7ccb1f0c689f77fe5dae4e0bb5d514db1cf5acb5be927bbcaa8576aca153981", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname, lmax=lmax, header_units='km',
r0_index=0, gm_index=1, errors=True)
def GRGM900C(lmax=900):
'''
GRGM900C is a GSFC 900 degree and order spherical harmonic model of the
gravitational potential of the Moon. This model applies a Kaula constraint
for degrees greater than 600.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Lemoine, F.G., Goossens, S., Sabaka, T.J., Nicholas, J.B., Mazarico, E.,
Rowlands, D.D., Loomis, B.D., Chinn, D.S., Neumann, G.A., Smith, D.E.,
Zuber, M.T. (2014) GRGM900C: A degree 900 lunar gravity model from
GRAIL primary and extended mission data, Geophysical Research Letters,
41, 3382-3389, doi:10.1002/2014GL060027.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/grail/grail-l-lgrs-5-rdr-v1/grail_1001/shadr/gggrx_0900c_sha.tab", # noqa: E501
known_hash=
"sha256:dab6ab06e0d3d7cbc594ea4bd03151a65534ed5fdf4f147ae38662428c04454e", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='km',
errors=True,
omega=_omega.value)
def GGM05C(lmax=360):
'''
GGM05C is a degree 360 model of the Earth's gravity field in a zero-tide
system. This model is based on data from altimetry, ground-based
measurements, and the satellites GOCE and GRACE. The error coefficients are
calibrated.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Ries, J., Bettadpur, S., Eanes, R., Kang, Z., Ko, U., McCullough, C.,
Nagel, P., Pie, N., Poole, S., Richter, T., Save, H., Tapley, B.
(2016). The Combined Gravity Model GGM05C, GFZ Data Services,
http://doi.org/10.5880/icgem.2016.002.
'''
fname = _retrieve(
url="http://icgem.gfz-potsdam.de/getmodel/gfc/778a683780a5b0ad3163f4772b97b9075a0a13c389d2bd8ea3f891b64cfa383d/GGM05C.gfc", # noqa: E501
known_hash="sha256:efb1781e748969dab2721f45365cd060b5963ffe4fd497006cc786f9e5241bf2", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname, lmax=lmax, format='icgem',
errors='calibrated',
omega=_egm2008.omega.value)
def MGNP180U(lmax=180):
'''
MGNP180U is a JPL 180 degree and order spherical harmonic model of the
gravitational potential of Venus.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Konopliv, A.S., Banerdt, W.B., Sjogren, W.L. (1999). Venus gravity: 180th
degree and order model, Icarus, 139, 3-18, doi:10.1006/icar.1999.6086.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/mgn/mgn-v-rss-5-gravity-l2-v1/mg_5201/gravity/shgj180u.a01", # noqa: E501
known_hash=
"sha256:d59e2bb90c104ca1157681454a4c016ed4d1cb0e496861b1d3b35829403cf53b", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
skip=236,
header=True,
r0_index=1,
gm_index=2,
header_units='km',
errors=True,
omega=_omega.value)
def EIGEN_6C4(lmax=2190):
'''
EIGEN_6C4 is a degree 2190 model of the Earth's gravity field in a
tide-free system. This model is based on data from altimetry, ground-based
measurements, and the satellites GOCE, GRACE, and LAGEOS. The error
coefficients are formal.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Förste, C., Bruinsma, S. L., Abrikosov, O., Lemoine, J.-M., Marty, J. C.,
Flechtner, F., Balmino, G., Barthelmes, F., Biancale, R. (2014).
EIGEN-6C4 The latest combined global gravity field model including GOCE
data up to degree and order 2190 of GFZ Potsdam and GRGS Toulouse, GFZ
Data Services, http://doi.org/10.5880/icgem.2015.1.
'''
fname = _retrieve(
url="http://icgem.gfz-potsdam.de/getmodel/gfc/7fd8fe44aa1518cd79ca84300aef4b41ddb2364aef9e82b7cdaabdb60a9053f1/EIGEN-6C4.gfc", # noqa: E501
known_hash="sha256:2ac274a66a25fb25bdddcec7074669867939345ad003bbc1ece3967450d48dc1", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname, lmax=lmax, format='icgem',
errors='formal', omega=_egm2008.omega.value,
encoding='iso-8859-1')
def EGM2008(lmax=2190):
'''
EGM2008 is a degree 2190 model of the Earth's gravity field in a
tide-free system. This model is based on data from altimetry, ground-based
measurements, and the satellite GRACE. The error coefficients are
calibrated.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Pavlis, N. K., Holmes, S. A., Kenyon, S. C., Factor, J. K. (2012). The
development and evaluation of the Earth Gravitational Model 2008
(EGM2008), Journal of Geophysical Research: Solid Earth, 117, B04406,
doi:10.1029/2011JB008916.
'''
fname = _retrieve(
url="http://icgem.gfz-potsdam.de/getmodel/gfc/c50128797a9cb62e936337c890e4425f03f0461d7329b09a8cc8561504465340/EGM2008.gfc", # noqa: E501
known_hash="sha256:ab5b524da073e63b5bdceb7ca47a0de07a26dd44a1c5798f39fc98dc80af70fd", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname, lmax=lmax, format='icgem',
errors='calibrated',
omega=_egm2008.omega.value)
def SWARM_MLI_2D_0501(lmax=133):
'''
SWARM_MLI_2D_0501 is a degree 133 magnetic field model of the Earth's
lithsophere that is based largely on satellite data. Though this model is
based largely on data from the SWARM mission, data from the CHAMP mission
and some ground-based measurements are also used.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Thébault, E., Vigneron, P., Maus, S., Chulliat, A., Sirol, O., Hulot, G.
(2013). Swarm SCARF dedicated lithospheric field inversion chain.
Earth, Planets and Space, 65, 7, doi:10.5047/eps.2013.07.008.
'''
fname = _retrieve(
url="ftp://swarm-diss.eo.esa.int/Level2longterm/MLI/SW_OPER_MLI_SHA_2D_00000000T000000_99999999T999999_0501.ZIP", # noqa: E501
known_hash="sha256:53b92d229ff9416c4cd5663975bdcb23f193f41e7212f2956685dae34dbc6f7f", # noqa: E501
downloader=_FTPDownloader(progressbar=True),
processor=_Unzip(),
path=_os_cache('pyshtools'),
)
return _SHMagCoeffs.from_file(fname[0], format='dov', r0=6371.2e3,
r0_index=None, lmax=lmax, header=True,
header2=True, skip=3, file_units='nT',
units='nT')
def GTMES150(lmax=150):
'''
GTMES150 is a GSFC 150 degree and order spherical harmonic model of the
shape of the planet Mercury. This model is based on 26 million laser
altimeter measurements and 557 radio occultations. The coefficients are in
units of meters.
Documentation for this model can be found on the PDS web site at
https://pds-geosciences.wustl.edu/
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/messenger/mess-h-rss_mla-5-sdp-v1/messrs_1001/data/shadr/gtmes_150v05_sha.tab", # noqa: E501
known_hash=
"sha256:c49d07c14b09c1b1ed1b4bfc4b42d2ff058875f5e949b50128b83ffa94c659b3", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
temp = _SHCoeffs.from_file(fname,
lmax=lmax,
header=True,
errors=True,
units='m')
temp.coeffs *= 1000.
temp.errors *= 1000.
return temp
def GRGM1200B(lmax=1200):
'''
GRGM1200B is a GSFC 1200 degree and order spherical harmonic model of the
gravitational potential of the Moon. This model applies a Kaula constraint
for degrees greater than 600.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Goossens, S., Sabaka, T.J., Wieczorek, M.A., Neumann, G.A., Mazarico, E.,
Lemoine, F.G., Nicholas, J.B., Smith. D.E., Zuber M.T. (2020).
High-resolution gravity field models from GRAIL data and implications
for models of the density structure of the Moon's crust. Journal of
Geophysical Research Planets, 125, e2019JE006086,
doi:10.1029/2019JE006086.
'''
fname = _retrieve(
url=
"https://core2.gsfc.nasa.gov/PGDA/data/MoonRM1/sha.grgm1200b_sigma", # noqa: E501
known_hash=
"sha256:f08a988b43f3eaa5a2089045a9b7e41e02f16542c7912b87ea34366fafa39bc5", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='m',
r0_index=1,
gm_index=0,
errors=True,
omega=_omega.value)
def JGMESS160A(lmax=160):
'''
JGMESS160A is a JPL 160 degree and order spherical harmonic model of the
gravitational potential of Mercury. This model applies a Kaula law
constraint to all degrees.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Konopliv, A.S., Park, R.S., Ermakov, A.I. (2020). The Mercury gravity
field, orientation, Love number, and ephemeris from the MESSENGER
radiometric tracking data, Icarus, 335, 253-260,
doi:10.1016/j.icarus.2019.07.020.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/messenger/mess-h-rss_mla-5-sdp-v1/messrs_1001/data/shadr/jgmess_160a_sha.tab", # noqa: E501
known_hash=
"sha256:14fa0129c4b5ef655e08a883a05a476a836a806349da607f84b3c2b2e3d899ca", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='km',
errors=True,
omega=_omega.value)
def GL1500E(lmax=1500):
'''
GL1500E is a JPL 1500 degree and order spherical harmonic model of
the gravitational potential of the Moon. This model applies a Kaula
constraint for degrees greater than 700.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Konopliv, A.S., Park, R.S., Yuan, D.-N., Asmar, S.W., Watkins, M.M.,
Williams, J.G., Fahnestock, E., Kruizinga, G., Paik, M., Strekalov, D.,
Harvey, N., Smith, D.E., Zuber, M.T. (2014). High-resolution lunar
gravity fields from the GRAIL Primary and Extended Missions,
Geophysical Research Letters, 41, 1452-1458, doi:10.1002/2013GL059066.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/grail/grail-l-lgrs-5-rdr-v1/grail_1001/shadr/jggrx_1500e_sha.tab", # noqa: E501
known_hash=
"sha256:93a7467b9241f6f94c131126c87fd3b81cfc3d223c474ee3444bf162b7c97f5a", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='km',
errors=True,
omega=_omega.value)
def ret(lmax=2160):
'''
Earth's rock-equivalent topography: Harmonic model of Earth's rock
equivalent topography, where ice and water masses are condensed to layers
of rock using a density of 2670 kg/m3.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Hirt, C., Rexer, M. (2015). Earth2014: 1 arc-min shape, topography, bedrock
and ice-sheet models - available as gridded data and degree-10,800
spherical harmonics, International Journal of Applied Earth Observation
and Geoinformation, 39, 103-112, doi:10.10.1016/j.jag.2015.03.001.
'''
fname = _retrieve(
url=
"http://ddfe.curtin.edu.au/gravitymodels/Earth2014/data_5min/shcs_to2160/Earth2014.RET2014.degree2160.bshc", # noqa: E501
known_hash=
"sha256:1fa87749532811614c00e9723dae1aa312e5511570d101bccb74bc40cb7dd5d1", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHCoeffs.from_file(fname, lmax=lmax, format='bshc', units='m')
def MoonTopo2600p(lmax=2600):
'''
MoonTopo2600p is a 2600 degree and order spherical harmonic model of the
shape of Earth's Moon in a principal axis coordinate system. The
coefficients are in units of meters.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Wieczorek, M.A. (2015). Gravity and Topography of the Terrestrial Planets,
Treatise on Geophysics, 2nd edition, Oxford, 153-193,
doi:10.1016/B978-0-444-53802-4.00169-X.
'''
fname = _retrieve(
url="https://zenodo.org/record/3870924/files/MoonTopo2600p.shape.gz",
known_hash=
"sha256:193146df894e2fef796df9d6142c78fae6fa5c183fd79d3f79eeb356602af69a", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHCoeffs.from_file(fname, lmax=lmax, units='m')
def surface(lmax=2160):
'''
Earth's physical surface: Harmonic model of the interface between the
atmosphere and Earth's surface (including water and ice).
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Hirt, C., Rexer, M. (2015). Earth2014: 1 arc-min shape, topography, bedrock
and ice-sheet models - available as gridded data and degree-10,800
spherical harmonics, International Journal of Applied Earth Observation
and Geoinformation, 39, 103-112, doi:10.10.1016/j.jag.2015.03.001.
'''
fname = _retrieve(
url=
"http://ddfe.curtin.edu.au/gravitymodels/Earth2014/data_5min/shcs_to2160/Earth2014.SUR2014.degree2160.bshc", # noqa: E501
known_hash=
"sha256:5694260d135c17427270ed18d48af23f4788e5fbc1dfb9dcb19f1cf9b401c9ce", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHCoeffs.from_file(fname, lmax=lmax, format='bshc', units='m')
def T2015_449(lmax=449):
'''
T2015_449 is a 449 degree and order spherical harmonic model of the
magnetic potential of the Moon. This model was used in Wieczorek (2018) and
is a spherical harmonic expansion of the global magnetic field model of
Tsunakawa et al. (2015). The coefficients are output in units of nT.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
References
----------
Tsunakawa, H., Takahashi, F., Shimizu, H., Shibuya, H., Matsushima, M.
(2015). Surface vector mapping of magnetic anomalies over the Moon
using Kaguya and Lunar Prospector observations, Journal of Geophysical
Research Planets, 120, 1160-1185, doi:10.1002/2014JE004785.
Wieczorek, M.A. (2018). Strength, depth, and geometry of magnetic sources
in the crust of the Moon from localized power spectrum analysis,
Journal of Geophysical Research Planets, 123, 291-316,
doi:10.1002/2017JE005418.
'''
fname = _retrieve(
url="https://zenodo.org/record/3873648/files/T2015_449.sh.gz",
known_hash=
"sha256:4db0b77b3863f38d6fb6e62c5c1116bf7123b77c5aad65df7dae598714edd655", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHMagCoeffs.from_file(fname,
lmax=lmax,
header=True,
file_units='T',
units='nT')
def tbi(lmax=2160):
'''
Topography of Earth's bedrock and ice: Harmonic model of the surface
relief, excluding water masses.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Hirt, C., Rexer, M. (2015). Earth2014: 1 arc-min shape, topography, bedrock
and ice-sheet models - available as gridded data and degree-10,800
spherical harmonics, International Journal of Applied Earth Observation
and Geoinformation, 39, 103-112, doi:10.10.1016/j.jag.2015.03.001.
'''
fname = _retrieve(
url=
"http://ddfe.curtin.edu.au/gravitymodels/Earth2014/data_5min/shcs_to2160/Earth2014.TBI2014.degree2160.bshc", # noqa: E501
known_hash=
"sha256:84a72ef25fe26fd746d2c6988c01840a12e9e414ee266e9357acb81faaaa6d5f", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHCoeffs.from_file(fname, lmax=lmax, format='bshc', units='m')
def Ravat2020(lmax=450):
'''
Ravat2020 is a 450 degree and order spherical harmonic model of the
magnetic potential of the Moon. This model is based on using magnetic
monopoles with an L1-norm regularisation. The coefficients are output
in units of nT.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
References
----------
Ravat, D., Purucker, M. E., Olsen, N. (2020). Lunar magnetic field models
from Lunar Prospector and SELENE/Kaguya along‐track magnetic field
gradients, Journal of Geophysical Research: Planets, 125,
e2019JE006187, doi:10.1029/2019JE006187.
'''
fname = _retrieve(
url=
"https://uknowledge.uky.edu/cgi/viewcontent.cgi?filename=4&article=1001&context=ees_data&type=additional", # noqa: E501
known_hash=
"sha256:dd1128d7819a8de097f3abeba93fee4cb80fced5bd63d56cca5a9bc70ac2bea9", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHMagCoeffs.from_file(fname,
lmax=lmax,
header=True,
skip=8,
header_units='km')
def Langlais2019(lmax=134):
'''
Langlais2019 is a 134 degree and order spherical harmonic model of the
magnetic potential of Mars. This model makes use of data from MGS MAG,
MGS ER and MAVEN MAG. The coefficients are output in units of nT.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
References
----------
Langlais, B., Thébault, E., Houliez, A., Purucker, M.E., Lillis, R.J.
(2019). A new model of the crustal magnetic field of Mars using MGS
and MAVEN. Journal of Geophysical Research: Planets, 124, 1542-1569,
doi:10.1029/2018JE005854.
'''
fname = _retrieve(
url=
"https://zenodo.org/record/3876714/files/Langlais2019.sh.gz?download=1", # noqa: E501
known_hash=
"sha256:3cad9e268f0673be1702f1df504a4cbcb8dba4480c7b3f629921911488fe247b", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHMagCoeffs.from_file(fname,
lmax=lmax,
skip=4,
r0=3393.5e3,
header=False,
file_units='nT',
name='Langlais2019',
units='nT')
def JGMESS160A_TOPOSIG(lmax=160):
'''
JGMESS160A_TOPOSIG is a JPL 160 degree and order spherical harmonic model
of the gravitational potential of Mercury. This model applies a constraint
similar to the Kaula constraint except that the uncertainty is given by the
corresponding magnitude of the gravity derived from topography coefficient.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Konopliv, A.S., Park, R.S., Ermakov, A.I. (2020). The Mercury gravity
field, orientation, Love number, and ephemeris from the MESSENGER
radiometric tracking data, Icarus, 335, 253-260,
doi:10.1016/j.icarus.2019.07.020.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/messenger/mess-h-rss_mla-5-sdp-v1/messrs_1001/data/shadr/jgmess_160a_toposig_sha.tab", # noqa: E501
known_hash=
"sha256:ad6d77e55968b9ddaea9cde03cb00ad6b630c81e8509e413e5b5b11213b3d848", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='km',
errors=True,
omega=_omega.value)
def MarsTopo2600(lmax=2600):
'''
MarsTopo2600 is a 2600 degree and order spherical harmonic model of the
shape of the planet Mars. The coefficients are in units of meters.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Wieczorek, M.A. (2015). Gravity and Topography of the Terrestrial Planets,
Treatise on Geophysics, 2nd edition, Oxford, 153-193,
doi:10.1016/B978-0-444-53802-4.00169-X.
'''
fname = _retrieve(
url="https://zenodo.org/record/3870922/files/MarsTopo2600.shape.gz",
known_hash=
"sha256:8882a9ee7ee405d971b752028409f69bd934ba5411f1c64eaacd149e3b8642af", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHCoeffs.from_file(fname,
lmax=lmax,
name='MarsTopo2600',
units='m')
def GGMES100V08(lmax=100):
'''
GGMES100V08 is a GSFC 100 degree and order spherical harmonic model of
the gravitational potential of Mercury. This model applies a Kaula
constraint to all degrees.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Genova, A., Goossens, S., Mazarico, E., Lemoine, F.G., Neumann, G.A.,
Kuang, W., Sabaka, T.J., Hauck, S.A. II, Smith, D.E., Solomon S.C.,
Zuber, M.T. (2019). Geodetic evidence that Mercury has a solid inner
core. Geophysical Research Letters, 46, 3625-3633,
doi:10.1029/2018GL081135.
'''
fname = _retrieve(
url=
"https://pds-geosciences.wustl.edu/messenger/mess-h-rss_mla-5-sdp-v1/messrs_1001/data/shadr/ggmes_100v08_sha.tab", # noqa: E501
known_hash=
"sha256:f81b33663ced0c6e05c775aa2d8c6c8eb99c41a20d4063d240fed536e45058fd", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='km',
errors=True,
omega=_omega.value)
def GMM3_RM1_1E0(lmax=150):
'''
GMM3_RM1_1E0 is a GSFC 150 degree and order spherical harmonic model of the
gravitational potential of Mars. This model uses the same data as GMM3, but
with a rank-minus-1 constraint based on gravity from surface topography for
degrees greater than 50 with a value of lambda equal to 1.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Goossens, S., Sabaka, T.J., Genova, A, Mazarico, E., Nicholas, J.B.,
Neumann, G.A. (2017), Evidence for a low bulk crustal density for Mars
from gravity and topography, Geophysical Research Letters, 44,
7686-7694, doi:10.1002/2017GL074172.
'''
fname = _retrieve(
url=
"https://core2.gsfc.nasa.gov/PGDA/data/MarsDensityRM1/sha.gmm3_l150_rm1_lambda_1", # noqa: E501
known_hash=
"sha256:b309917362bd2014df42a62cb19ea321ee8db97997b0688eda2774deb46ef538", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHGravCoeffs.from_file(fname,
lmax=lmax,
header_units='m',
r0_index=1,
gm_index=0,
errors=False,
omega=_omega.value,
name='GMM3_RM1_1E0')
def NGDC_720_V3(lmax=740):
'''
NGDC_720_V3 is a magnetic field model of the Earth's lithsophere that was
compiled from satellite, marine, aeromagnetic and ground-based magnetic
surveys. The model was original developped in ellipsoidal harmonics up to
degree 720, but the model provided here was subsequently converted to
spherical harmonics to degree 740. The first 15 degrees of the model are
equal to zero.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Maus, S. (2010). An ellipsoidal harmonic representation of Earth’s
lithospheric magnetic field to degree and order 720, Geochem. Geophys.
Geosyst., 11, Q06015, doi:10.1029/2010GC003026.
'''
fname = _retrieve(
url="https://www.ngdc.noaa.gov/geomag/NGDC720/data/geomag/NGDC-720_V3p0.cof.gz", # noqa: E501
known_hash="sha256:d9a0f89f2845548a3a42214e1044169b0772d407a83719d146390af2591a4007", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHMagCoeffs.from_file(fname, r0=6371.2e3, lmax=lmax, skip=14,
header=False, file_units='nT', units='nT')
