Skip to content

Commit 4edf7a0

Browse files
authored
Extend IGRF section of the user guide (#582)
1 parent 07dff34 commit 4edf7a0

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

doc/user_guide/igrf.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ The date can be provided as an `ISO 8601 formatted date
3737
If the time is omited, the default is midnight. If a timezone is omited, the
3838
default is UTC.
3939

40+
.. tip::
41+
42+
Typically, for a short survey (a few days to a week), using a single time for
43+
calculating the IGRF is adequate, since IGRF secular variations on these time
44+
scales are typically small. However, if the survey is longer, or high precision is
45+
required, it may be best to separate the survey by days or flights and calculate
46+
the IGRF using a more appropriate datetime for each section.
47+
4048
Calculating at given points
4149
---------------------------
4250

@@ -62,9 +70,19 @@ We can print the results in a better way to view them:
6270

6371
.. jupyter-execute::
6472

65-
print(" | ".join([f"B{c}={v:.1f} nT" for c, v in zip("enu", field)]))
73+
print(f"Be={field[0]:.1f} nT | Bn={field[1]:.1f} nT | Bu={field[2]:.1f} nT")
74+
75+
We can convert this tuple of values into intensity (or amplitude), inclination and
76+
declination using
77+
:func:`harmonica.magnetic_vec_to_angles`.
78+
79+
.. jupyter-execute::
80+
81+
intensity, inc, dec = hm.magnetic_vec_to_angles(*field)
82+
print(f"{intensity=:.1f} nT | {inc=:.1f}\N{DEGREE SIGN} | {dec=:.1f}\N{DEGREE SIGN}")
6683
67-
Multiple values can be given as numpy arrays or lists:
84+
In addition to calculating the IGRF field at one location, multiple coordinates can be
85+
given as numpy arrays or lists:
6886

6987
.. jupyter-execute::
7088

0 commit comments

Comments
 (0)