-
Notifications
You must be signed in to change notification settings - Fork 103
/
__init__.py
386 lines (336 loc) · 16.1 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
'''
Datasets related to the planet Earth.
Topography
----------
Earth2012 : Hirt et al. (2012)
Earth2014 : Hirt and Rexer (2015)
Gravity
-------
EGM2008 : Pavlis et al. (2012); degree 2190
EIGEN_6C4 : Förste et al. (2014); degree 2190
GGM05C : Ries et al. (2016); degree 360
GOCO06S : Kvas et al. (2019); degree 300, satellite only
EIGEN_GRGS_RL04_MEAN_FIELD : Lemoine et al. (2019); degree 300, satellite only
XGM2019E : Zingerle et al. (2019); degree 2190
Magnetic field
--------------
IGRF_13 : Thébault et al. (2015); degree 13
SWARM_MLI_2D_0501 : Thébault et al. (2013); degree 133
NGDC_720_V3 : Maus (2010); degree 740
WDMAM2_800 : Lesur et al. (2016); degree 800
Thebault2021 : Thebault et al. (2021); degree 1050
'''
from pooch import os_cache as _os_cache
from pooch import retrieve as _retrieve
from pooch import HTTPDownloader as _HTTPDownloader
from pooch import FTPDownloader as _FTPDownloader
from pooch import Unzip as _Unzip
from ...shclasses import SHGravCoeffs as _SHGravCoeffs
from ...shclasses import SHMagCoeffs as _SHMagCoeffs
from ...constants.Earth import egm2008 as _egm2008
from . import Earth2012
from . import Earth2014
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, name='EGM2008',
encoding='utf-8')
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', name='EIGEN_6C4')
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, name='GGM05C',
encoding='utf-8')
def GOCO06S(lmax=300):
'''
GOCO06S is a degree 300 model of the Earth's gravity field in a zero-tide
system. This model is based solely on satellite data. The error
coefficients are formal.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Kvas, A., Mayer-Gürr, T., Krauss, S., Brockmann, J. M., Schubert, T.,
Schuh, W.-D., Pail, R., Gruber, T., Jäggi, A., Meyer, U. (2019).
The satellite-only gravity field model GOCO06s, GFZ Data Services,
http://doi.org/10.5880/ICGEM.2019.002.
'''
fname = _retrieve(
url="http://icgem.gfz-potsdam.de/getmodel/gfc/32ec2884630a02670476f752d2a2bf1c395d8c8d6d768090ed95b4f04b0d5863/GOCO06s.gfc", # noqa: E501
known_hash="sha256:351d9d20b84cd2c0f52ce77146b1e3b774f408200b579ffaf98593cf3d271819", # 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,
name='GOCO06S', encoding='utf-8')
def EIGEN_GRGS_RL04_MEAN_FIELD(epoch=None, lmax=300):
'''
EIGEN_GRGS_RL04_MEAN_FIELD is a degree 300 model of the Earth's gravity
field in a tide-free system. This model is based solely on satellite
data. The error coefficients are formal.
Parameters
----------
epoch : str or float
The epoch time to calculate time-variable coefficients in YYYYMMDD.DD
format.
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Lemoine, J.-M., Bourgogne, S., Biancale, R., Reinquin, F. (2019). The new
time-variable gravity field model for POD of altimetric satellites
based on GRACE+SLR RL04 from CNES/GRGS, IDS Workshop, 24-29 September,
Ponta Delgada, Portugal.
'''
fname = _retrieve(
url="http://icgem.gfz-potsdam.de/getmodel/gfc/96e984f23a31505411d943341767e9ff082ad2c77fbbdcba1be2e393cf35110a/EIGEN-GRGS.RL04.MEAN-FIELD.gfc", # noqa: E501
known_hash="sha256:ea5d99d84da42d0eedccb381c282604a1a42fd64d1f9e25bba796b7e8838732f", # 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,
epoch=epoch,
name='EIGEN_GRGS_RL04_MEAN_FIELD',
encoding='utf-8')
def XGM2019E(lmax=2190):
'''
XGM2019E is a degree 2190 model of the Earth's gravity field in a zero-tide
system. This combined model is based on data from altimetry, ground-based
measurements, topography, and satellites. The error coefficients are
formal.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Zingerle, P., Pail, R., Gruber, T., Oikonomidou, X. (2020). The combined
global gravity field model XGM2019e, Journal of Geodesy, 94, 66,
doi:10.1007/s00190-020-01398-0.
'''
fname = _retrieve(
url="http://icgem.gfz-potsdam.de/getmodel/gfc/eeb03971cf6e533e6eeb6b010336463286dcda0846684248d5530acf8e800055/XGM2019e_2159.gfc", # noqa: E501
known_hash="sha256:ee24f7cf68f45b44cdbf3ccbf57e7382c7667869356061419f00f2ca951861e4", # 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,
name='XGM2019E', encoding='utf-8')
def IGRF_13(lmax=13, year=2020.):
'''
IGRF-13 is a degree 13 time variable model of the Earth's main magnetic
field that is valid between 1900 and 2020. Coefficients are provided in 5
year intervals, and for a given year, the values of the coefficients are
interpolated linearly between adjacent entries. For years between 2020 and
2025, the coefficients are extrapolated linearly using the provided secular
variation.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
year : float, optional, default = 2020.
The year to compute the coefficients.
Reference
---------
Thébault, E., and 47 coauthors (2015). International Geomagnetic Reference
Field: the 12th generation, Earth, Planets and Space, 67, 79,
doi:10.1186/s40623-015-0228-9.
'''
fname = _retrieve(
url="https://www.ngdc.noaa.gov/IAGA/vmod/coeffs/igrf13coeffs.txt",
known_hash="sha256:460b8d8beb9b4df84febe4f0b639f0dd54dccfe8ff0970616287b015fa721425", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
path=_os_cache('pyshtools'),
)
return _SHMagCoeffs.from_file(fname, format='igrf', r0=6371.2e3,
lmax=lmax, year=year, file_units='nT',
name='IGRF_13', units='nT', encoding='utf-8')
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',
name='NGDC_720_V3', units='nT',
encoding='utf-8')
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', name='WDMAM2_800',
units='nT', encoding='utf-8')
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',
name='SWARM_MLI_2D_0501', units='nT',
encoding='utf-8')
def Thebault2021(lmax=1050):
'''
Thebault2021 is a degree 1050 magnetic field model of the Earth's
lithsophere that is based on a combination of surface and satellite data.
This model includes data from CHAMP, SWARM, and WDMAP-2 near-surface scalar
measurements. The coefficients of the first 15 degrees are all zero.
Parameters
----------
lmax : int, optional
The maximum spherical harmonic degree to return.
Reference
---------
Thébault, E., Hulot, G., Langlais, B., Vigneron, P. (2021). A spherical
harmonic model of Earth's lithospheric magnetic field up to degree
1050, Geophysical Research Letters, 48, e2021GL095147,
doi:10.1029/2021GL095147.
'''
fname = _retrieve(
url="https://zenodo.org/record/5546528/files/Spherical_HarmonicModel_GRL.zip?download=1", # noqa: E501
known_hash="sha256:d3ce3f049158cb055d1e69efaa39f0618d808d1e01f18efb5058b6ac5fa4e78d", # noqa: E501
downloader=_HTTPDownloader(progressbar=True),
processor=_Unzip(),
path=_os_cache('pyshtools'),
)
return _SHMagCoeffs.from_file(fname[0], format='shtools', r0=6371.2e3,
r0_index=None, lmax=lmax, header=False,
header2=False, skip=13, file_units='nT',
name='Thebault2021', units='nT',
encoding='utf-8')
__all__ = ['Earth2012', 'Earth2014', 'EGM2008', 'EIGEN_6C4',
'GGM05C', 'GOCO06S', 'EIGEN_GRGS_RL04_MEAN_FIELD', 'XGM2019E',
'IGRF_13', 'NGDC_720_V3', 'WDMAM2_800', 'SWARM_MLI_2D_0501',
'Thebault2021']