| Toolkit Contents Description |
Table of ContentsToolkit Contents Description Introduction Version Information Directory Structure and Contents DATA DOC ETC EXE INCLUDE LIB SRC BRIEF CHRONOS CKBRIEF COMMNT COOKBOOK DSKBRIEF DSKEXP FRMDIFF INSPEKT MKDSK MKSPK MSOPCK SPACIT CSPICE SPKDIFF SPKMERGE CSUPPORT TOBIN TOXFR VERSION Using the Toolkit All Users Repeat Users First Time Users Appendix -- NAIF's File Naming Conventions Toolkit Contents DescriptionIntroduction
Most C compilers come with a large set of compilation options that can be used when compiling source code. The compiler options we (NAIF) used when creating the various object libraries are discussed in the section "LIB" that appears later in this document. Version Information
Creation Date: Fri Apr 7 16:41:22 PDT 2017 Version : CSPICE.............V.N0066 Directory Structure and Contents
(installation directory)
|
cspice
|
makeall.csh
cspice also contains several subdirectories that will be described in
more detail in the following sections.
(installation directory)
|
cspice
|
data
doc
etc
exe
include
lib
src
DATA
(installation directory)
|
cspice
|
data
|
cook_01.tc
cook_01.tls
cook_01.tpc
cook_01.tsc
cook_01.tsp
cook_02.tc
cook_02.tsp
geophysical.ker
DOC
(installation directory)
|
cspice
|
doc
|
dscriptn.txt
version.txt
cspice.idx
*.ug
*.req
*.txt
This package also includes HTML version of the documentation. It is
provided in the HTML subdirectory of the DOC directory. The
``index.html'' file contains links to the individual HTML documents
spread across numerous branches of this subdirectory tree.
(installation directory)
|
cspice
|
doc
|
html
|
index.html
...
ETC
(installation directory)
|
cspice
|
etc
EXE
(installation directory)
|
cspice
|
exe
|
brief
chronos
ckbrief
commnt
simple
states
subpt
tictoc
dskbrief
dskexp
frmdiff
inspekt
mkdsk
mkspk
msopck
spacit
spkdiff
spkmerge
tobin
toxfr
version
INCLUDE
(installation directory)
|
cspice
|
include
|
SpiceCK.h
SpiceCel.h
SpiceDLA.h
SpiceDSK.h
SpiceDtl.h
SpiceEK.h
SpiceEll.h
SpiceErr.h
SpiceFrm.h
SpiceGF.h
SpiceOccult.h
SpiceOsc.h
SpicePln.h
SpiceSPK.h
SpiceSrf.h
SpiceUsr.h
SpiceZad.h
SpiceZdf.h
SpiceZfc.h
SpiceZim.h
SpiceZmc.h
SpiceZpl.h
SpiceZpr.h
SpiceZrnm.h
SpiceZst.h
f2c.h
f2cMang.h
fio.h
fmt.h
fp.h
lio.h
rawio.h
signal1.h
zzalloc.h
zzerror.h
LIB
All static libraries are compiled using the following compiler options:
-m64 -c -ansi -O2 -fPIC -DNON_UNIX_STDIOThe libraries contained in this directory are listed below. Each library is discussed in more detail later in the section devoted to the SRC directory.
(installation directory)
|
cspice
|
lib
|
cspice.a
csupport.a
SRC
(installation directory)
|
cspice
|
src
|
brief_c
chrnos_c
ckbref_c
commnt_c
cook_c
dskbrief_c
dskexp_c
frmdif_c
inspkt_c
mkdsk_c
mkspk_c
msopck_c
spacit_c
cspice
spkdif_c
spkmrg_c
csupport
tobin_c
toxfr_c
versn_c
BRIEF
This directory contains the BRIEF main program, supporting routines, and a script to create the executable program brief.
(installation directory)
|
cspice
|
src
|
brief_c
|
main.x
brief.pgm
*.c
*.h
mkprodct.csh
CHRONOS
This directory contains the CHRONOS main program, supporting routines, and a script to create the executable program chronos.
(installation directory)
|
cspice
|
src
|
chrnos_c
|
main.x
chronos.pgm
*.c
mkprodct.csh
CKBRIEF
This directory contains the CKBRIEF main program, supporting routines, and a script to create the executable program ckbrief.
(installation directory)
|
cspice
|
src
|
ckbref_c
|
main.x
ckbrief.pgm
*.c
mkprodct.csh
COMMNT
This directory contains the COMMNT main program and a script to create the executable file commnt.
(installation directory)
|
cspice
|
src
|
commnt_c
|
main.x
commnt.pgm
*.h
mkprodct.csh
COOKBOOK
This directory contains the COOKBOOK source files and a script to create the executable files.
(installation directory)
|
cspice
|
src
|
cook_c
|
simple.pgm
states.pgm
subpt.pgm
tictoc.pgm
mkprodct.csh
DSKBRIEF
This directory contains the DSKBRIEF main program, supporting routines, and a script to create the executable program dskbrief.
(installation directory)
|
cspice
|
src
|
dskbrief_c
|
main.x
dskbrief.pgm
*.c
*.h
mkprodct.csh
DSKEXP
This directory contains the DSKEXP main program, supporting routines, and a script to create the executable program dskexp.
(installation directory)
|
cspice
|
src
|
dskexp_c
|
main.x
dskexp.pgm
*.c
*.h
mkprodct.csh
FRMDIFF
This directory contains the FRMDIFF main program, supporting routines, and a script to create the executable program frmdiff.
(installation directory)
|
cspice
|
src
|
frmdif_c
|
main.x
frmdiff.pgm
*.c
*.h
mkprodct.csh
INSPEKT
This directory contains the INSPEKT main program, supporting routines, and a script to create the executable program inspekt.
(installation directory)
|
cspice
|
src
|
inspkt_c
|
main.x
inspekt.pgm
*.c
*.h
mkprodct.csh
MKDSK
This directory contains the MKDSK main program, supporting routines, and a script to create the executable program mkdsk.
(installation directory)
|
cspice
|
src
|
mkdsk_c
|
main.x
mkdsk.pgm
*.c
*.h
mkprodct.csh
MKSPK
This directory contains the MKSPK main program, supporting routines, and a script to create the executable program mkspk.
(installation directory)
|
cspice
|
src
|
mkspk_c
|
main.x
mkspk.pgm
*.c
*.h
mkprodct.csh
MSOPCK
This directory contains the MSOPCK main program, supporting routines, and a script to create the executable program msopck.
(installation directory)
|
cspice
|
src
|
msopck_c
|
main.x
msopck.pgm
*.c
*.h
mkprodct.csh
SPACIT
This directory contains the SPACIT main program, supporting routines, and a script to create the executable program spacit.
(installation directory)
|
cspice
|
src
|
spacit_c
|
main.x
spacit.pgm
*.c
*.h
mkprodct.csh
CSPICE
This directory also contains a script for creating CSPICE.
(installation directory)
|
cspice
|
src
|
cspice
|
*.c
*.h
mkprodct.csh
SPKDIFF
This directory contains the SPKDIFF main program, supporting routines, and a script to create the executable program spkdiff.
(installation directory)
|
cspice
|
src
|
spkdif_c
|
main.x
spkdiff.pgm
*.c
*.h
mkprodct.csh
SPKMERGE
This directory contains the SPKMERGE main program, supporting routines, and a script to create the executable file spkmerge.
(installation directory)
|
cspice
|
src
|
spkmrg_c
|
main.x
spkmerge.pgm
*.c
*.h
mkprodct.csh
CSUPPORT
This directory contains the CSUPPORT library source files and a script to create the object library csupport.a.
(installation directory)
|
cspice
|
src
|
csupport
|
*.c
*.h
mkprodct.csh
TOBIN
This directory contains the TOBIN main program, supporting routines, and a script to create the executable program tobin.
(installation directory)
|
cspice
|
src
|
tobin_c
|
main.x
tobin.pgm
*.h
mkprodct.csh
TOXFR
This directory contains the TOXFR main program, supporting routines, and a script to create the executable program toxfr.
(installation directory)
|
cspice
|
src
|
toxfr_c
|
main.x
toxfr.pgm
*.h
mkprodct.csh
VERSION
This directory contains the VERSION main program. and a script to create the executable program version.
(installation directory)
|
cspice
|
src
|
version
|
main.x
version.pgm
mkprodct.csh
Using the ToolkitAll Users
The Toolkit contains two styles of documentation: a plain text version and a hyper-linked HTML version. NAIF recommends you use the HTML version because of the convenience of the hyper-linking. To do that load the top level index of the HTML documentation -- ``doc/html/index.html'' -- into a web browser. Repeat Users
Be aware that sometimes a bug fix or a small algorithmic change in the new SPICE code could result in small changes in numeric results; this could show up in your regression test cases. First Time Users
Please note that NAIF assumes you are familiar with how to write code in the language you have chosen, and that you know how to compile, link (``make'') and execute programs on your computer. If this is not the case you should first take some generic programming lessons before trying to tackle SPICE. Appendix -- NAIF's File Naming Conventions
Source code modules:
*.pgm Fortran or C source files for program modules. *.for Fortran source code files. *.f *.inc Fortran include files. *.c C source code files. *.h C header files. *.pro IDL source code files. *.m MATLAB source code files. *.java Java source code files.Executables, libraries, object files:
(no ext) Executable files. *.exe *.o Object files. *.obj *.a Object library files. *.lib *.olb *.so Shared object library files. *.dll *.mex* MATLAB shared object library files. *.dlm IDL and MATLAB library definition modules. *.def *.class Java class files.Documents:
*.req Text format Required Reading files. *.ug Text format User's Guides. *.idx Permuted index files. *.txt Text format documentation files. *.tex TeX files. *.dvi Device independent files produced by TeX. *.ps Postscript files. *.pdf PDF files. *.htm HTML files. *.html *.css Style sheet files. *.args Javadoc arguments files.SPICE Kernel files:
*.bc Binary CK (pointing) files. *.bdb Binary DBK (database) files. *.bds Binary DSK (digital shape) files. *.bep Binary EK (events) Science Plan files. *.bes Binary EK (events) Sequence files. *.bpc Binary PCK (planetary rotation) files. *.bsp Binary SPK (ephemeris) files. *.ten Text EK (events) Experimenter's Notebook files. *.tep Text EK (events) Science Plan files. *.tf Text FK (frame definitions) files. *.ti Text IK (instrument parameters) files. *.tls Text LSK (leapseconds) files. *.tm Text MK (meta-kernels, aka ``furnsh'') files *.tpc Text PCK (planetary constants) files. *.tsc Text SCLK (spacecraft clock) files. *.xc Transfer format CK (pointing) files. *.xdb Transfer format DBK (database) files. *.xds Transfer format DSK (digital shape) files. *.xep Transfer format EK (events) Science Plan files. *.xes Transfer format EK (events) Sequence files. *.xpc Transfer format PCK (planetary rotation) files. *.xsp Transfer format SPK (ephemeris) files.Build scripts:
mkprodct.csh Unix build scripts. mkprodct.sh mkprodct.tcsh mkprodct.com VAX/Dec Alpha build scripts. mkprodct.bat PC/DOS, PS/WIN build scripts. mkprodct.mpw MAC MPW build scripts. mkprodct.mas MAC Apple Script build scripts. |