Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 1.2 KB

index.rst

File metadata and controls

57 lines (35 loc) · 1.2 KB

Welcome to MagCoordPy's documentation!

A python package for working with magnetic coordinate transformations. The documentation is available at <https://magcoordpy.readthedocs.io/en/latest/>.

Installation

pip install magcoordpy

Example usage

from magcoordpy import coord_transforms
long_geo = np.arange(-180, 190, 10)
lati_geo = np.zeros(len(long_array))
alti_geo = np.zeros(len(long_array))
lat_cd, lon_cd, r_cd = coord_transforms.geodetic2cd(lati_geo, long_geo, alti_geo, year=2021.0)

Functions

.. toctree::
   :maxdepth: 2
   :caption: Contents:

:doc:`ort_mag_coo_sys`
Documentation for orthogonal magnetic coordinate systems functions

Authors

Please use github issues to make bug reports and request new functionality. Contributions are always welcome.

References

Laundal, K.M., Richmond, A.D. Magnetic Coordinate Systems. Space Sci Rev 206, 27–59 (2017). <https://doi.org/10.1007/s11214-016-0275-y>

Indices and tables