Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
KCollins authored Oct 8, 2024
1 parent dbeeba4 commit 95cd852
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,20 @@ conjugate_map
Files and scripts relating to geomagnetic conjugate map. Run in Binder
here: |Binder|

There are two example notebooks available: - ``MWE.ipynb``: Minimal
working example demonstrating conjugate calculations. -
``ConjugateMap.ipynb``: More in-depth examples using COMNAP, Madrigal
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.
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)``.
Expand Down

0 comments on commit 95cd852

Please sign in to comment.