Skip to main content

Library for computing geomagnetic conjugate points.

Project description

PyPI version DOI Documentation Status Coverage Status Test Status

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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

conjugate_map-0.3.0-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file conjugate_map-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: conjugate_map-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.1

File hashes

Hashes for conjugate_map-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a07d11ac301eb3ec5f7c7a746d85f49d530e9ce37e0363fd24ad4ccff33fab20
MD5 a40ca2eabc662086c04dc091e71f67a5
BLAKE2b-256 efe6135d08f57ca067d58c23f0706a904e417745dcf6b19ec734512861269f52

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page