Skip to content

PlanetMapper: An open source Python package for visualising, navigating and mapping Solar System observations

License

Notifications You must be signed in to change notification settings

ortk95/planetmapper

Repository files navigation

PlanetMapper logo

PyPI Version Conda Version Publish Workflow Status Checks Workflow Status Documentation Status Coverage Status JOSS Paper DOI

PlanetMapper is an open source Python package for visualising, navigating and mapping Solar System observations.

For full documentation and API reference, visit planetmapper.readthedocs.io.

pip install planetmapper --upgrade
conda install -c conda-forge planetmapper

Requires Python 3.10+

Citing PlanetMapper

If you use PlanetMapper in your research, please cite the following paper:

King et al., (2023). PlanetMapper: A Python package for visualising, navigating and mapping Solar System observations. Journal of Open Source Software, 8(90), 5728, https://doi.org/10.21105/joss.05728

Citation BibTeX entry
@article{king_2023_planetmapper,
  author  = {King, Oliver R. T. and Fletcher, Leigh N.},
  doi     = {10.21105/joss.05728},
  journal = {Journal of Open Source Software},
  month   = oct,
  number  = {90},
  pages   = {5728},
  title   = {{PlanetMapper: A Python package for visualising, navigating and mapping Solar System observations}},
  url     = {https://joss.theoj.org/papers/10.21105/joss.05728},
  volume  = {8},
  year    = {2023}
}

Each PlanetMapper version is also archived on Zenodo at doi.org/10.5281/zenodo.7963121.

Key features

Screenshot of the PlanetMapper graphical user interface showing an observation of Europa being navigated

body = planetmapper.Body('saturn', '2020-01-01')
body.plot_wireframe_radec()
plt.show()

Image of Saturn generated with PlanetMapper showing the orientation of Saturn and its rings

Plot of a mapped Jupiter observation, generated with PlanetMapper, showing observed and mapped versions of the Jupiter data

Contributing

If you spot a bug, or want contribute code to PlanetMapper, check out the contributing guidelines.

Help and support

If you have any questions, suggestions or feedback, please visit our support page and get in touch!