Welcome to planetMagFields’ documentation!

planetMagFields is a package that provides an easy interface to plot and analyze planetary magnetic field data. planetMagFields is free and open source and is available at https://github.com/AnkitBarik/planetMagFields .

Documentation

The prerequisites, installation and features are described in the pages below. However, for easy and quick visualization, skip ahead to the Jupyter notebook section. The details of the math are explained in the Mathematics section.

• 1. Prerequisites
• 2. Installation
  • 2.1. Using pip
  • 2.2. Using setup.py
  • 2.3. Using PYTHONPATH
• 3. Features and examples
  • 3.1. The Planet class
  • 3.2. Field filtering using Planet.plot_filt
  • 3.3. Potential extrapolation
  • 3.4. Get field along a trajectory
  • 3.5. Quickplot using the magField.py script
• 4. Mathematics
  • 4.1. References
• 5. Magnetic field models
• 6. Map projections
• 7. Jupyter Notebook
• 8. Python API
  • Planet
  • get_models()

Citing planetMagFields

If you’re using planetMagFields for your work, please cite the JOSS paper:

Barik et al., (2024). planetMagFields: A Python package for analyzing and plotting planetary magnetic field data. Journal of Open Source Software, 9(97), 6677, https://doi.org/10.21105/joss.06677

@article{Barik2024,
    doi = {10.21105/joss.06677},
    url = {https://doi.org/10.21105/joss.06677},
    year = {2024},
    publisher = {The Open Journal},
    volume = {9},
    number = {97},
    pages = {6677},
    author = {Barik, Ankit and Angappan, Regupathi},
    title = {planetMagFields: A Python package for analyzing and plotting planetary magnetic field data},
    journal = {Journal of Open Source Software}
}

Code contribution and reporting issues

planetMagFields is an open source project and anyone is welcome to contribute to it. If you wish to contribute to this project, please follow the guidelines below:

• Please make sure the tests pass before opening a pull request.

• Please follow Python PEP-8 guidelines when it comes to code style.

• If you wish to add new data file, please name it following the convention <planet>_<model>.dat, where planet and model denote the names of the planet and the magnetic field model being used. See the data directory for examples.

• If you implement a new feature or data source, please update the documentation accordingly.

Please report any bugs or other issues through GitHub Issues.