Metadata-Version: 2.1
Name: magcoordpy
Version: 0.2.2
Summary: A python package for working with magnetic coordinate transformations
License: MIT
Author: Giorgio Savastano
Author-email: giorgio.savastano@uniroma1.it
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: docs
Requires-Dist: numpy (>=1.22.2,<2.0.0)
Requires-Dist: pymap3d (>=2.7.2,<3.0.0)
Requires-Dist: urllib3 (>=1.26.8,<2.0.0)
Description-Content-Type: text/markdown

# MagCoordPy

![test-main](https://github.com/giorgiosavastano/magcoordpy/actions/workflows/python-test-main.yml/badge.svg)
![coverage-main](https://img.shields.io/codecov/c/github/giorgiosavastano/magcoordpy)
![license](https://img.shields.io/github/license/giorgiosavastano/magcoordpy)

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)


It includes the following functions (not exhaustive list):

* geodetic2cd --> transformation from geodetic to centered dipole
* cd2geodetic --> transformation from centered dipole to geodetic


## Authors

- Giorgio Savastano (<giorgiosavastano@gmail.com>)

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>

