SpiceyPy: The NASA JPL NAIF SPICE toolkit wrapper written in Python.
Clone or download
AndrewAnnex Add gfevnt (#275)
* added gfevnt
Latest commit 5a89ea1 Oct 10, 2018

README.rst

SpiceyPy

SpiceyPy is a Python wrapper for the NAIF C SPICE Toolkit (N66), compatible with Python 2 and 3, written using ctypes.

Continuous Integration Code Coverage Docs Chat Citation
Travis Build Status Windows Build Status Coverage Status Documentation Status Join the chat Citation

Introduction

SpiceyPy is a python wrapper for the SPICE Toolkit. SPICE is an essential tool for scientists and engineers alike in the planetary science field for Solar System Geometry. Please visit the NAIF website for more details about SPICE.

IMPORTANT: I have no current affiliation with NASA, NAIF, or JPL. The code is provided "as is", use at your own risk.

Citing SpiceyPy

If you are publishing work that uses SpiceyPy, please cite SpiceyPy and the SPICE toolkit. The citation information for SPICE can be found on the NAIF website. To cite SpiceyPy please utilize the zenodo DOI badge at the top of this readme. To cite information about SpiceyPy, usership, and how it works please cite my 2017 abstract, available with citation info at : https://ui.adsabs.harvard.edu/#abs/2017LPICo1986.7081A.

Installation

PyPI Conda Forge
PyPI Conda Version

SpiceyPy can be installed using pip by running: pip install spiceypy

Anaconda users should use the conda-forge distribution of SpiceyPy by running: conda config --add channels conda-forge conda install spiceypy

If you wish to install spiceypy from source first download or clone the project. Then run python setup.py install. To uninstall run pip uninstall spiceypy.

Documentation

The SpiceyPy docs are available at: spiceypy.readthedocs.org. The documentation for SpiceyPy is intentionally abridged so as to utilize the excellent documentation provided by the NAIF. Please refer to C and IDL documentation available on the NAIF website for in-depth explanations. Each function docstring has a link to the corresponding C function in the NAIF docs at a minimum.

How to Help

Feedback is always welcomed, if you discover that a function is not working as expected, submit an issue detailing how to reproduce the problem. If you utilize SpiceyPy frequently please consider contributing to the project by citing me using the zenodo DOI above.

Known Working Environments:

SpicyPy is compatible with modern Linux, Mac, and Windows environments. Since the package is a wrapper, any environment not supported by the NAIF is similarly not supported by SpiceyPy. If you run into issues with your system please submit an issue with details. Please note that support for Python minor versions are generally phased out as newer versions are released.

  • OS: OS X, Linux, Windows
  • CPU: 64bit only!
  • Python 2.7, 3.3, 3.4, 3.5, 3.6, 3.7

Acknowledgements

DaRasch wrote spiceminer, which I looked at to get SpiceCells working, thanks!