wmm-package

The <code>wmm</code> package calculates magnetic field at a given location and time according to the World Magnetic Model.

Calculate magnetic field at a given location and time according to
the World Magnetic Model (WMM). Both the main field and secular variation
components are returned. This functionality is useful for physicists and
geophysicists who need orthogonal components from WMM. Currently, this package
supports annualized time inputs between 2000 and 2025. If desired, users can
specify which WMM version to use, e.g., the original WMM2015 release or the
recent out-of-cycle WMM2015 release. Methods used to implement WMM, including
the Gauss coefficients for each release, are described in the following
publications: Chulliat et al (2020) <doi:10.25923/ytk1-yx35>,
Chulliat et al (2019) <doi:10.25921/xhr3-0t19>,
Chulliat et al (2015) <doi:10.7289/V5TB14V7>,
Maus et al (2010) <https://www.ngdc.noaa.gov/geomag/WMM/data/WMMReports/WMM2010_Report.pdf>,
McLean et al (2004) <https://www.ngdc.noaa.gov/geomag/WMM/data/WMMReports/TRWMM_2005.pdf>,
and Macmillian et al (2000) <https://www.ngdc.noaa.gov/geomag/WMM/data/WMMReports/wmm2000.pdf>.

Will Frierson

World Magnetic Model

wmm function

This package has 1 exported function, <code><a rd-options="" href="/link/GetMagneticFieldWMM?package=wmm&version=1.1.1" data-mini-rdoc="wmm::GetMagneticFieldWMM">GetMagneticFieldWMM</a></code>, which returns a list of:<ul>
<li>Main field and secular variation vector components in nT and nT/yr, resp.</li>
<li>Magnetic element intensities (i.e., horizontal and total intensities, <code>h</code> &amp; <code>f</code>) in nT with their secular variation in nT/yr</li>
<li>Magnetic element angles (i.e., inclination and declination, <code>i</code> &amp; <code>d</code>) in degrees with their secular variation in deg/yr</li>
</ul><code>GetMagneticFieldWMM(lambda_t, phi_t, h_t, t)</code> = (<code>x</code>, <code>y</code>, <code>z</code>, <code>xDot</code>, <code>yDot</code>, <code>zDot</code>, <code>h</code>, <code>f</code>, <code>i</code>, <code>d</code>, <code>hDot</code>, <code>fDot</code>, <code>iDot</code>, <code>dDot</code>)

WMM functions

Thanks to:<ul>
<li>The WMM team past, present, and future for making the Gauss coefficients public domain</li>
<li>Alex Breeze for tech reviewing the original version of this code, years ago</li>
</ul>

wmm: wmm: R Implementation of World Magnetic Model

Description

Arguments

WMM functions

Acknowledgments