Skip to content

Commit

Permalink
Update index.rst
Browse files Browse the repository at this point in the history
adds a bit of a description to Spice and SpiceyPy to the index page for the docs
  • Loading branch information
AndrewAnnex committed Feb 28, 2021
1 parent 9839092 commit 859034f
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
Welcome to SpiceyPy's documentation!
====================================
Introduction
------------

SpiceyPy is a python wrapper for the `SPICE Toolkit <https://naif.jpl.nasa.gov/naif/>`__.
SPICE provides access and tools to interact with planetary and spacecraft ephemeris and ancillary engineering information.
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.
SpiceyPy can be cited using the JOSS DOI (`https://doi.org/10.21105/joss.02050`) or with the following:

Annex et al., (2020). SpiceyPy: a Pythonic Wrapper for the SPICE Toolkit. Journal of Open Source Software, 5(46), 2050, https://doi.org/10.21105/joss.02050

Instructions for how to cite the SPICE Toolkit are available on the NAIF website:

https://naif.jpl.nasa.gov/naif/credit.html.

To cite information about SpiceyPy usage statistics, please cite my 2017 and or 2019 abstracts as appropriate below:

1. 2017 abstract: `<https://ui.adsabs.harvard.edu/abs/2017LPICo1986.7081A/abstract>`__.
2. 2019 abstract: `<https://ui.adsabs.harvard.edu/abs/2019LPICo2151.7043A/abstract>`__.

Documentation Overview
----------------------

This is the documentation for SpiceyPy. The documentation for each
function in the wrapper is in large part copied from the "Abstract"
Expand Down

0 comments on commit 859034f

Please sign in to comment.