chaosmagpy.coordinate_utils.qdipole

chaosmagpy.coordinate_utils.qdipole(time, radius, theta, phi, datafile=None, fortranlib=None)[source]

Compute quasi-dipole (QD) coordinates, magnetic local time (MLT) and QD basevectors for a given geographic position.

Parameters:
timefloat or ndarray, shape (…)

Time given as MJD2000 (modified Julian date).

radiusfloat or ndarray, shape (…)

Array containing the radius in kilometers.

thetafloat or ndarray, shape (…)

Array containing the colatitude in degrees \([0^\circ,180^\circ]\).

phifloat or ndarray, shape (…)

Array containing the longitude in degrees.

datafilestr, optional

Path to custom coefficient file (defaults to apexsh.dat file in apexpy).

fortranlibstr, optional

Path to Fortran Apex CPython library (defaults to the linked library file in apexpy.

Returns:
qdlatndarray, shape (…)

Quasi-dipole latitide in degrees.

qdlonndarray, shape (…)

Quasi-dipole longitude in degrees.

mltndarray, shape (…)

Magnetic local time in hours.

f1ndarray, shape (2, …)

East and north components of the first QD basevector.

f2ndarray, shape (2, …)

East and north components of the second QD basevector.

References

This function was implemented using modified code from the Apexpy package on GitHub.