Skip Navigation: Avoid going through Home page links and jump straight to content
NASA Logo    + View the NASA Portal  
NAIF

Questions About How to Use a SPICE API (Subroutine)

All SPICE APIs (subroutines) include substantial user documentation, provided in a consistent form. This documentation is provided at the top of every API in what is called the "header." For FORTRAN versions it also occurs at every entry point within an API for those APIs where multiple entry points are defined.

The "header" information may be viewed by opening up the relevant source code API using any available text editor or text viewer. Even easier access to these headers is obtained using the Toolkit's HTML documentation capabilities, accessible from the /doc/html/index.html file contained in every Toolkit, and also from the html documentation pages of this website.

Extensive additional documentation about all members of major families of APIs (e.g. the SPK family or the rotations family) is provided in a series of technical reference documents often referred to as "required reading" documents. Text-format versions, having file names like *.req, are provided in the /doc directory within each Toolkit. HTML versions may be accessed from the /doc/html/index.html file contained in every Toolkit, and from the html documentation pages of this website.

A compendium of the approximately 100 Most Used APIs showing calling sequences and some examples is provided in each Toolkit. This document is also available from the /doc/html/index.html file contained in every Toolkit, and from the Documentation pages of this website.

PDS Menu
 NASA | Caltech | Privacy | Image Policy | FAQ | JPL Feedback
o Clearance: CL#05-2438
o Site Manager: Charles Acton
o Webmaster: Ron Baalke
o Last Updated: