planetmapper


Nameplanetmapper JSON
Version 1.9.1 PyPI version JSON
download
home_pagehttps://github.com/ortk95/planetmapper
SummaryPlanetMapper: A Python package for visualising, navigating and mapping Solar System observations
upload_time2024-02-16 16:25:46
maintainer
docs_urlNone
authorOliver King
requires_python>=3.10.0
licenseMIT
keywords planetmapper astronomy space science spice ephemeris planetary-science
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # ![PlanetMapper logo](https://raw.githubusercontent.com/ortk95/planetmapper/main/docs/images/logo_wide_transparent.png)

[![PyPI Version](https://img.shields.io/pypi/v/planetmapper?label=PyPI)](https://pypi.org/project/planetmapper/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/planetmapper?label=conda)](https://anaconda.org/conda-forge/planetmapper)
[![Publish Workflow Status](https://github.com/ortk95/planetmapper/actions/workflows/python-publish.yml/badge.svg)](https://github.com/ortk95/planetmapper/actions/workflows/python-publish.yml)
[![Checks Workflow Status](https://github.com/ortk95/planetmapper/actions/workflows/checks.yml/badge.svg?branch=main)](https://github.com/ortk95/planetmapper/actions/workflows/checks.yml)
[![Documentation Status](https://readthedocs.org/projects/planetmapper/badge/?version=latest)](https://planetmapper.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://coveralls.io/repos/github/ortk95/planetmapper/badge.svg?branch=main)](https://coveralls.io/github/ortk95/planetmapper?branch=main)
[![JOSS Paper DOI](https://joss.theoj.org/papers/10.21105/joss.05728/status.svg)](https://doi.org/10.21105/joss.05728)

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

## [Documentation](https://planetmapper.readthedocs.io)
For full documentation and [API reference](https://planetmapper.readthedocs.io/en/latest/documentation.html), visit [planetmapper.readthedocs.io](https://planetmapper.readthedocs.io/en/latest/index.html).


## [Installation](https://planetmapper.readthedocs.io/en/latest/installation.html)
```bash
pip install planetmapper --upgrade
```

```bash
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

<details>
<summary>Citation BibTeX entry</summary>

```bibtex
@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}
}
```

</details>

Each PlanetMapper version is also archived on Zenodo at [doi.org/10.5281/zenodo.7963121](https://doi.org/10.5281/zenodo.7963121).


## Key features
### [Fit and map astronomical observations using a full featured user interface](https://planetmapper.readthedocs.io/en/latest/user_interface.html)
[![Screenshot of the PlanetMapper graphical user interface showing an observation of Europa being navigated](https://raw.githubusercontent.com/ortk95/planetmapper/main/docs/images/gui_fitting.png)](https://planetmapper.readthedocs.io/en/latest/user_interface.html)

### [Easily visualise solar system observations with just a few lines of code](https://planetmapper.readthedocs.io/en/latest/general_python_api.html#wireframe-plots)

```python
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](https://raw.githubusercontent.com/ortk95/planetmapper/main/docs/images/saturn_wireframe_radec.png)](https://planetmapper.readthedocs.io/en/latest/general_python_api.html#wireframe-plots)

### [Convert coordinates, generate backplanes and project maps of telescope observations](https://planetmapper.readthedocs.io/en/latest/general_python_api.html)
[![Plot of a mapped Jupiter observation, generated with PlanetMapper, showing observed and mapped versions of the Jupiter data](https://raw.githubusercontent.com/ortk95/planetmapper/main/docs/images/jupiter_mapped.png)](https://planetmapper.readthedocs.io/en/latest/general_python_api.html)


## Contributing

If you spot a bug, or want contribute code to PlanetMapper, check out the [contributing guidelines](https://github.com/ortk95/planetmapper/blob/main/CONTRIBUTING.md).

## Help and support

If you have any questions, suggestions or feedback, please [visit our support page and get in touch](https://planetmapper.readthedocs.io/en/latest/help.html)!

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ortk95/planetmapper",
    "name": "planetmapper",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10.0",
    "maintainer_email": "",
    "keywords": "planetmapper,astronomy,space,science,spice,ephemeris,planetary-science",
    "author": "Oliver King",
    "author_email": "oliver.king95@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/3f/0f/d2a5473bf1fcda097678711179a0680acb8fe1802979eb648218cfa2a4b9/planetmapper-1.9.1.tar.gz",
    "platform": null,
    "description": "# ![PlanetMapper logo](https://raw.githubusercontent.com/ortk95/planetmapper/main/docs/images/logo_wide_transparent.png)\n\n[![PyPI Version](https://img.shields.io/pypi/v/planetmapper?label=PyPI)](https://pypi.org/project/planetmapper/)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/planetmapper?label=conda)](https://anaconda.org/conda-forge/planetmapper)\n[![Publish Workflow Status](https://github.com/ortk95/planetmapper/actions/workflows/python-publish.yml/badge.svg)](https://github.com/ortk95/planetmapper/actions/workflows/python-publish.yml)\n[![Checks Workflow Status](https://github.com/ortk95/planetmapper/actions/workflows/checks.yml/badge.svg?branch=main)](https://github.com/ortk95/planetmapper/actions/workflows/checks.yml)\n[![Documentation Status](https://readthedocs.org/projects/planetmapper/badge/?version=latest)](https://planetmapper.readthedocs.io/en/latest/?badge=latest)\n[![Coverage Status](https://coveralls.io/repos/github/ortk95/planetmapper/badge.svg?branch=main)](https://coveralls.io/github/ortk95/planetmapper?branch=main)\n[![JOSS Paper DOI](https://joss.theoj.org/papers/10.21105/joss.05728/status.svg)](https://doi.org/10.21105/joss.05728)\n\nPlanetMapper is an open source Python package for visualising, navigating and mapping Solar System observations.\n\n## [Documentation](https://planetmapper.readthedocs.io)\nFor full documentation and [API reference](https://planetmapper.readthedocs.io/en/latest/documentation.html), visit [planetmapper.readthedocs.io](https://planetmapper.readthedocs.io/en/latest/index.html).\n\n\n## [Installation](https://planetmapper.readthedocs.io/en/latest/installation.html)\n```bash\npip install planetmapper --upgrade\n```\n\n```bash\nconda install -c conda-forge planetmapper\n```\n\n_Requires Python 3.10+_\n\n\n## Citing PlanetMapper\nIf you use PlanetMapper in your research, please cite the following paper:\n\n> 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\n\n<details>\n<summary>Citation BibTeX entry</summary>\n\n```bibtex\n@article{king_2023_planetmapper,\n  author  = {King, Oliver R. T. and Fletcher, Leigh N.},\n  doi     = {10.21105/joss.05728},\n  journal = {Journal of Open Source Software},\n  month   = oct,\n  number  = {90},\n  pages   = {5728},\n  title   = {{PlanetMapper: A Python package for visualising, navigating and mapping Solar System observations}},\n  url     = {https://joss.theoj.org/papers/10.21105/joss.05728},\n  volume  = {8},\n  year    = {2023}\n}\n```\n\n</details>\n\nEach PlanetMapper version is also archived on Zenodo at [doi.org/10.5281/zenodo.7963121](https://doi.org/10.5281/zenodo.7963121).\n\n\n## Key features\n### [Fit and map astronomical observations using a full featured user interface](https://planetmapper.readthedocs.io/en/latest/user_interface.html)\n[![Screenshot of the PlanetMapper graphical user interface showing an observation of Europa being navigated](https://raw.githubusercontent.com/ortk95/planetmapper/main/docs/images/gui_fitting.png)](https://planetmapper.readthedocs.io/en/latest/user_interface.html)\n\n### [Easily visualise solar system observations with just a few lines of code](https://planetmapper.readthedocs.io/en/latest/general_python_api.html#wireframe-plots)\n\n```python\nbody = planetmapper.Body('saturn', '2020-01-01')\nbody.plot_wireframe_radec()\nplt.show()\n```\n\n[![Image of Saturn generated with PlanetMapper showing the orientation of Saturn and its rings](https://raw.githubusercontent.com/ortk95/planetmapper/main/docs/images/saturn_wireframe_radec.png)](https://planetmapper.readthedocs.io/en/latest/general_python_api.html#wireframe-plots)\n\n### [Convert coordinates, generate backplanes and project maps of telescope observations](https://planetmapper.readthedocs.io/en/latest/general_python_api.html)\n[![Plot of a mapped Jupiter observation, generated with PlanetMapper, showing observed and mapped versions of the Jupiter data](https://raw.githubusercontent.com/ortk95/planetmapper/main/docs/images/jupiter_mapped.png)](https://planetmapper.readthedocs.io/en/latest/general_python_api.html)\n\n\n## Contributing\n\nIf you spot a bug, or want contribute code to PlanetMapper, check out the [contributing guidelines](https://github.com/ortk95/planetmapper/blob/main/CONTRIBUTING.md).\n\n## Help and support\n\nIf you have any questions, suggestions or feedback, please [visit our support page and get in touch](https://planetmapper.readthedocs.io/en/latest/help.html)!\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "PlanetMapper: A Python package for visualising, navigating and mapping Solar System observations",
    "version": "1.9.1",
    "project_urls": {
        "Documentation": "https://planetmapper.readthedocs.io/",
        "Download": "https://pypi.org/project/planetmapper/",
        "GitHub": "https://github.com/ortk95/planetmapper",
        "Homepage": "https://github.com/ortk95/planetmapper",
        "Paper": "https://doi.org/10.21105/joss.05728"
    },
    "split_keywords": [
        "planetmapper",
        "astronomy",
        "space",
        "science",
        "spice",
        "ephemeris",
        "planetary-science"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3e0becc0ce0bf5fd138d7d1e7e421ec63967c59d874aba44a62e1e32a12fac93",
                "md5": "2deb02c49e54df0ff2f01482263e9b08",
                "sha256": "976c14310f42459122616ab8e903d50ad90944f29131a5b4c205846c5d746379"
            },
            "downloads": -1,
            "filename": "planetmapper-1.9.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2deb02c49e54df0ff2f01482263e9b08",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10.0",
            "size": 115377,
            "upload_time": "2024-02-16T16:25:43",
            "upload_time_iso_8601": "2024-02-16T16:25:43.825434Z",
            "url": "https://files.pythonhosted.org/packages/3e/0b/ecc0ce0bf5fd138d7d1e7e421ec63967c59d874aba44a62e1e32a12fac93/planetmapper-1.9.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3f0fd2a5473bf1fcda097678711179a0680acb8fe1802979eb648218cfa2a4b9",
                "md5": "e87f185df5fd90555c2e72fa51e960df",
                "sha256": "1ba62ccf7c53ded8c3e875a2feaa15d2bb9837ad3e62d19b5537f9a7ba44c576"
            },
            "downloads": -1,
            "filename": "planetmapper-1.9.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e87f185df5fd90555c2e72fa51e960df",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10.0",
            "size": 144841,
            "upload_time": "2024-02-16T16:25:46",
            "upload_time_iso_8601": "2024-02-16T16:25:46.208339Z",
            "url": "https://files.pythonhosted.org/packages/3f/0f/d2a5473bf1fcda097678711179a0680acb8fe1802979eb648218cfa2a4b9/planetmapper-1.9.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-16 16:25:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ortk95",
    "github_project": "planetmapper",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "planetmapper"
}
Oliver King
Elapsed time: 0.19723s