PDS_VERSION_ID = PDS3
RECORD_TYPE = STREAM
OBJECT = TEXT
PUBLICATION_DATE = 1999-08-12
NOTE = "NAIF Toolkit Directory Structure and
Contents for the Sun. Structure, contents,
and installation for other platforms will
be similar; see TK_FTP.TXT for information
on obtaining other versions."
END_OBJECT = TEXT
END
Introduction
===========================================================================
This document describes the structure and contents of the latest
version of the SPICE toolkit for Sun/Solaris.
FORTRAN
--------------------------------------------------------
Most FORTRAN 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 Oct 9 18:29:24 PDT 1998
Version : GENERIC_TOOLKIT.........V.N0049
Directory Structure and Contents
===========================================================================
toolkit
--------------------------------------------------------
The toolkit directory contains the file makeall.csh. This is a C shell
script that builds all of the object libraries and executables in the
toolkit.
(installation directory)
|
toolkit
|
makeall.csh
toolkit also contains several subdirectories that will be described in
more detail in the following sections.
(installation directory)
|
toolkit
|
data
doc
etc
exe
lib
src
1. DATA
This directory contains example data for use with various
programs. These files are provided only as examples and are
not intended for use for any serious analysis or planning
work.
2. DOC
This directory contains all of the documentation for this
package. This includes User's Guides for the programs,
Required Reading files for SPICELIB, documents describing the
contents of SPICELIB such as the Permuted Index , and
documents describing the contents and installation of the
Toolkit.
3. EXE
This directory contains all of the package executables, and
where applicable, scripts to run the executables.
4. ETC
The subdirectories of this directory contain product-specific
files that are neither source, documentation, nor data. This
includes configuration files, set up files, and help files.
5. LIB
This directory contains all of the object libraries.
6. SRC
The subdirectories of this directory contain all of the
source for the products in this toolkit package.
DATA
--------------------------------------------------------
The DATA directory contains all of the NAIF Toolkit data that is
pertinent for this toolkit package. This data is intended only to be
used with the TOOLKIT programs, and is included only to help you get
started using the Toolkit.
(installation directory)
|
toolkit
|
data
|
cook_01.tc
cook_01.tls
cook_01.tpc
cook_01.tsc
cook_01.tsp
cook_02.tc
cook_02.tsp
DOC
--------------------------------------------------------
The DOC directory contains all of the toolkit toolkit documentation
that is available on-line. This includes the user's guides for the
programs, Required Reading files for SPICELIB, documents describing
the contents and porting of SPICELIB, and documents describing the
installation and contents of the Toolkit. Please note that the INSPEKT
User's Guide is not available on-line.
(installation directory)
|
toolkit
|
doc
|
dscriptn.txt
version.txt
intro.ps
mostused.ps
spicelib.idx
*.ug
*.req
*.txt
ETC
--------------------------------------------------------
The ETC directory contains all files for the Toolkit products that are
not source, documentation, or data such as set up files, configuration
files or help files.
(installation directory)
|
toolkit
|
etc
EXE
--------------------------------------------------------
The EXE directory contains the NAIF Toolkit executables and, where
applicable, scripts to run executables.
(installation directory)
|
toolkit
|
exe
|
brief
chronos
commnt
fstspk
simple
states
subpt
tictoc
inspekt
spacit
starsb
tobin
toxfr
version
LIB
--------------------------------------------------------
The LIB directory contains the object libraries for this toolkit
package.
All libraries are compiled using the following FORTRAN compiler
options:
-C -u
The 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)
|
toolkit
|
lib
|
spicelib.a
support.a
SRC
--------------------------------------------------------
The SRC directory contains one subdirectory for each product in the
NAIF Toolkit. Each of these product directories contains the source
code files and procedures to create the executable or object library.
(installation directory)
|
toolkit
|
src
|
brief
chronos
commnt
cookbook
inspekt
spacit
spicelib
starsb
support
tobin
toxfr
version
BRIEF
BRIEF is a utility program that allows you to summarize the ephemeris
coverage for one or more SPK files.
This directory contains the BRIEF main program, supporting routines,
and a script to create the executable program brief.
(installation directory)
|
toolkit
|
src
|
brief
|
brief.pgm
*.f
MkProdct.csh
CHRONOS
CHRONOS is a utility program that allows you to easily convert from
one representation of time to another.
This directory contains the CHRONOS main program, supporting routines,
and a script to create the executable program @chronos.
(installation directory)
|
toolkit
|
src
|
chronos
|
chronos.pgm
*.f
mkprodct.csh
COMMNT
COMMNT is a utility program that is used to add comments, extract
comments, read comments, or delete comments in SPICE SPK, CK and EK
files.
This directory contains the COMMNT main program and a script to create
the executable file commnt.
(installation directory)
|
toolkit
|
src
|
commnt
|
commnt.pgm
MkProdct.csh
COOKBOOK
The cookbook programs are sample programs that demonstrate how to use
SPICELIB routines to obtain state vectors, convert between different
time representations, and solve simple geometry problems.
This directory contains the COOKBOOK source files and a script to
create the executable files.
(installation directory)
|
toolkit
|
src
|
cookbook
|
fstspk.pgm
simple.pgm
states.pgm
subpt.pgm
tictoc.pgm
MkProdct.csh
INSPEKT
INSPEKT is a program that allows you to examine the contents of an
events component of an E-kernel.
This directory contains the INSPEKT main program, supporting routines,
and a script to create the executable program inspekt.
(installation directory)
|
toolkit
|
src
|
inspekt
|
inspekt.pgm
*.f
*.inc
MkProdct.csh
SPACIT
SPACIT (space-it) is a utility program that performs three functions:
it converts transfer format SPK, CK and EK files to binary format, it
converts binary SPK, CK and EK files to transfer format, and it
summarizes the contents of binary SPK, CK and EK files.
This directory contains the SPACIT main program, supporting routines,
and a script to create the executable program spacit.
(installation directory)
|
toolkit
|
src
|
spacit
|
spacit.pgm
*.f
MkProdct.csh
SPICELIB
This directory contains the SPICELIB FORTRAN source files needed for
creating the SPICELIB object library. The library contains
approximately 1000 functions, subroutines, and entry points.
This directory also contains a script for creating SPICELIB.
(installation directory)
|
toolkit
|
src
|
spicelib
|
*.f
MkProdct.csh
STARSB
STARSB (star-essbee) is a utility program that creates a SPICE type 1
star catalog from a "master star catalog."
This directory contains the STARSB main program and a script for
creating the executable program starsb.
(installation directory)
|
toolkit
|
src
|
starsb
|
starsb.pgm
mkprodct.csh
SUPPORT
SUPPORT is a Fortran source code library that contains routines that
support the Toolkit programs. These routines are not intended to be
used by anyone except NAIF. These routines are not officially
supported and may undergo radical changes such as calling sequence
changes. They may even be deleted. Do not use them!
This directory contains the SUPPORT library source files and a script
to create the object library support.a.
(installation directory)
|
toolkit
|
src
|
support
|
*.f
MkProdct.csh
TOBIN
TOBIN (to-bin) is a command line utility program that converts
transfer format SPK, CK and EK files to binary format.
This directory contains the TOBIN main program, supporting routines,
and a script to create the executable program tobin.
(installation directory)
|
toolkit
|
src
|
tobin
|
tobin.pgm
*.f
MkProdct.csh
TOXFR
TOXFR (to-transfer) is a command line utility program that converts
binary format SPK, CK and EK files to transfer format.
This directory contains the TOXFR main program, supporting routines,
and a script to create the executable program toxfr.
(installation directory)
|
toolkit
|
src
|
toxfr
|
toxfr.pgm
*.f
MkProdct.csh
VERSION
VERSION is a command line utility program that prints the current
version number of the SPICE Toolkit.
This directory contains the VERSION main program. and a script to
create the executable program version.
(installation directory)
|
toolkit
|
src
|
version
|
version.@main
mkprodct.csh
Using the NAIF Toolkit Package
===========================================================================
After the installation has been completed successfully, there are a
few things that you need to do to get started using SPICELIB. We
recommend that you print out the source code for the cookbook programs
and examine it. Try running some of the cookbook programs yourself.
The cookbook programs demonstrate how to use SPICELIB routines to
obtain state vectors, convert between different time representations,
and solve simple geometry problems.
Once you're ready to get your hands dirty, you should read the
required reading files for SPICELIB. The required reading files are
located in the directory ``doc'' (see above) with the extension
``.req''. They are text files that describe families of subroutines
and how they interact with the rest of SPICELIB.
The most important required reading files are: TIME, KERNEL, SPK, CK,
SCLK, SPC, and NAIF_IDS. You should read at least these.
After you've done these things, you're ready to start programming with
SPICELIB!
Appendix -- NAIF's File Naming Conventions
===========================================================================
NAIF follows a set of conventions for naming files based on the
contents of the files. This allows you to find certain types of files
in a directory tree quickly.
1. *.f
Fortran source code files.
2. *.pgm
Fortran source code files for program modules.
3. *.c
C source code files.
4. *.o
object files.
5. *.a
Object library files.
6. *.tsp
Transfer format SPK (ephemeris) files.
7. *.bsp
Binary SPK (ephemeris) files.
8. *.tc
Transfer format CK (pointing) files.
9. *.bc
Binary CK (pointing) files.
10. *.ti
Text IK (instrument parameters) files.
11. *.tls
Leapseconds kernel files.
12. *.tpc
Physical and cartographic constants kernel files.
13. *.tsc
Spacecraft clock coefficients kernel files.
14. *.txt
Text format documentation files.
15. *.ug
Text format User's Guides.
16. *.tex
Files suitable for processing with the typesetting program
TeX.
17. *.ps
Standard postscript files.
18. *.dvi
Device independent files produced by TeX.
19. *.req
Text format SPICELIB Required Reading files.
20. mk(product name).csh
Unix script files for creating products.
21. (product name)
Executable files. For example, spacit is the executable file
for the product spacit.
These conventions are preliminary. As coordination with SFOC and the
Planetary Data System (PDS) occurs, these conventions may be revised.
|