conjugate_map

Files and scripts relating to geomagnetic conjugate map. Run in Binder here:

There are two example notebooks available:

• MWE.ipynb: Minimal working example demonstrating conjugate calculations.

• ConjugateMap.ipynb: More in-depth examples using COMNAP, Madrigal

and other databases to produce animated maps with plotly express.

The following functions are imported from conj_calc.py:

• conjugate_map.findconj() : function to compute conjugate points for a given location at a given time and date.

• conjugate_map.conjcalc() : function to take in a dataframe and add columns for all stages of calculating conjugate points.

• conjugate_map.calc_mlat_rings() : function to calculate magnetic graticules for a given latitude and datetime.

You can read the documentation for each function by running, e.g., help(calc_mlat_rings).

Installation

To install from pypi: pip install conjugate-map

To install from source: Clone git repo and run python -m pip install . from top level of directory.

Testing

To test locally, run python -m unittest from top level of directory.

conjugate_map

conjugate_map is a Python library for computing geomagnetic conjugate points.

Check out the Usage section for further information, including how to Install the project.

Note

This project is under active development.

Contents

• Home
• Usage
  • Install
  • Example Notebooks
  • How to Cite
• API
  • Main Functions
    • calc_mlat_rings()
    • conjcalc()
    • findconj()