Download this file

PDS_VERSION_ID        = PDS3                                                  
RECORD_TYPE           = STREAM                                                
OBJECT                = TEXT                                                  
  PUBLICATION_DATE      = 1995-03-13                                          
  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.  Compiled       
                                 from notes provided by Hester Neilan."       
END_OBJECT            = TEXT                                                  
END                                                                           
                                                                              
                                                                              
                                                                              
NAIF Toolkit Directory Structure and Contents for the Sun                     
===========================================================================   
                                                                              
                                                                              
NAIF                                                                          
--------------------------------------------------------                      
                                                                              
     The NAIF directory contains one subdirectory, TOOLKIT. The TOOLKIT       
     tree contains all of the files that make up the NAIF Toolkit.            
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                              toolkit                                         
                                                                              
                                                                              
TOOLKIT                                                                       
--------------------------------------------------------                      
                                                                              
     The TOOLKIT directory contains the file make_toolkit.csh. This is a C    
     shell script that builds all of the object libraries and executables     
     in the TOOLKIT.                                                          
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                              toolkit                                         
                                 |                                            
                            make_toolkit.csh                                  
                                                                              
     TOOLKIT also contains several subdirectories that will be described in   
     more detail in the following sections.                                   
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                  |                                           
                                 naif                                         
                                  |                                           
                               toolkit                                        
                                  |                                           
          +-------+-------+-------+-------+----------+                        
          |       |       |       |       |          |                        
         src     lib     exe     doc     etc    example_data                  
                                                                              
         1.   SRC                                                             
                                                                              
              The subdirectories of this directory contain all of the         
              source for the products in the TOOLKIT.                         
                                                                              
         2.   LIB                                                             
                                                                              
              This directory contains all of the TOOLKIT object libraries.    
                                                                              
         3.   EXE                                                             
                                                                              
              This directory contains all of the TOOLKIT executables, and     
              where applicable, scripts to run the executables.               
                                                                              
         4.   DOC                                                             
                                                                              
              This directory contains all of the TOOLKIT documentation.       
              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 Module Summary,      
              and documents describing the contents and installation of the   
              Toolkit.                                                        
                                                                              
         5.   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.     
                                                                              
              The subdirectory build contains the C shell script that         
              creates the toolkit object libraries and executables.           
                                                                              
         6.   EXAMPLE_DATA                                                    
                                                                              
              This directory contains example data for use with the           
              COOKBOOK and SPTEST programs. These files are to be used only   
              with these programs.                                            
                                                                              
                                                                              
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.    
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                   |                                          
                                  naif                                        
                                   |                                          
                                toolkit                                       
                                   |                                          
                                  src                                         
                                   |                                          
           +----------+--------+---+-----+---------+---------+---------+      
           |          |        |         |         |         |         |      
        spicelib   support   spacit   commnt   cookbook   sptest   inspekt    
                                                                              
                                                                              
SPICELIB                                                                      
                                                                              
     SPICELIB is a Fortran source code library that contains approximately    
     650 functions, subroutines, and entry points.                            
                                                                              
     This directory contains the SPICELIB source files.                       
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                              toolkit                                         
                                 |                                            
                                src                                           
                                 |                                            
                              spicelib                                        
                                                                              
                              *.f                                             
                                                                              
                                                                              
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.                
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                              toolkit                                         
                                 |                                            
                                src                                           
                                 |                                            
                              support                                         
                                                                              
                              *.f                                             
                                                                              
                                                                              
SPACIT                                                                        
                                                                              
     SPACIT 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 source code for the SPACIT main program      
     and supporting routines.                                                 
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                               toolkit                                        
                                 |                                            
                                src                                           
                                 |                                            
                               spacit                                         
                                                                              
                               spacit.main                                    
                               *.f                                            
                                                                              
                                                                              
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 source file.             
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                               toolkit                                        
                                 |                                            
                                src                                           
                                 |                                            
                               commnt                                         
                                                                              
                               commnt.main                                    
                                                                              
                                                                              
COOKBOOK                                                                      
                                                                              
     The cookbook programs are sample programs that demonstrate how to use    
     SPICELIB routines to obtain state vectors, convert between different     
     time representations, manipulate the comments in binary SPK and CK       
     files, and solve simple geometry problems.                               
                                                                              
     This directory contains the COOKBOOK program source files.               
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                               toolkit                                        
                                 |                                            
                                src                                           
                                 |                                            
                              cookbook                                        
                                                                              
                              fstspk.main                                     
                              simple.main                                     
                              states.main                                     
                              subpt.main                                      
                              tictoc.main                                     
                                                                              
                                                                              
INSPEKT                                                                       
                                                                              
     INSPEKT is a program that allows you to examine the contents of an       
     events component of an E-kernel.                                         
                                                                              
     This directory contains the source code for the INSPEKT main program     
     and supporting routines.                                                 
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                               toolkit                                        
                                 |                                            
                                src                                           
                                 |                                            
                              inspekt                                         
                                                                              
                              inspekt.main                                    
                              *.f                                             
                              *.inc                                           
                                                                              
                                                                              
SPTEST                                                                        
                                                                              
     SPTEST is a utility program that tests the SPK file readers by           
     comparing states read on the NAIF VAX with states read on the target     
     machine.                                                                 
                                                                              
     This directory contains the SPTEST program source file.                  
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                               toolkit                                        
                                 |                                            
                                src                                           
                                 |                                            
                               sptest                                         
                                                                              
                               sptest.main                                    
                                                                              
                                                                              
LIB                                                                           
--------------------------------------------------------                      
                                                                              
     The LIB directory contains spicelib.a, the object library for            
     SPICELIB. It also contains the object library support.a, but this        
     library is for use by the Toolkit programs only. Do not link your        
     applications with it!                                                    
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                                toolkit                                       
                                 |                                            
                                lib                                           
                                                                              
                                spicelib.a                                    
                                support.a                                     
                                                                              
                                                                              
EXE                                                                           
--------------------------------------------------------                      
                                                                              
     The EXE directory contains the NAIF Toolkit executables and, where       
     applicable, scripts to run executables.                                  
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                                toolkit                                       
                                 |                                            
                                exe                                           
                                                                              
                                commnt                                        
                                fstspk                                        
                                inspekt                                       
                                simple                                        
                                spacit                                        
                                sptest                                        
                                states                                        
                                subpt                                         
                                tictoc                                        
                                                                              
                                                                              
DOC                                                                           
--------------------------------------------------------                      
                                                                              
     The DOC directory contains all of the TOOLKIT documentation that is      
     available on-line. This includes the user's guides for the programs,     
     all Required Reading files for SPICELIB, all 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.                                   
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                                toolkit                                       
                                 |                                            
                                doc                                           
                                                                              
                                commnt.ug                                     
                                fstspk.ug                                     
                                simple.ug                                     
                                spacit.ug                                     
                                sptest.ug                                     
                                states.ug                                     
                                subpt.ug                                      
                                tictoc.ug                                     
                                *.req                                         
                                category.txt                                  
                                libsum.txt                                    
                                permuted_index.txt                            
                                porting.txt                                   
                                toolkit_install.txt                           
                                toolkit_description.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. It also contains the C shell script used to build   
     the toolkit object libraries and executables.                            
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                   |                                          
                                  naif                                        
                                   |                                          
                                toolkit                                       
                                   |                                          
                                  etc                                         
                                   |                                          
           +---------+-------+----+---+--------+--------+-------+             
           |         |       |        |        |        |       |             
        spicelib  support  spacit   commnt  cookbook  sptest  build           
                                                              build_it.csh    
                                                                              
                                                                              
EXAMPLE_DATA                                                                  
--------------------------------------------------------                      
                                                                              
     The EXAMPLE_DATA directory contains all of the NAIF Toolkit data. This   
     data is intended only to be used with the TOOLKIT programs, and is       
     included only to help you get started using the Toolkit.                 
                                                                              
        (directory under which you installed the NAIF Toolkit)                
                                 |                                            
                                naif                                          
                                 |                                            
                             example_data                                     
                                                                              
                             cook_01.tc                                       
                             cook_01.tls                                      
                             cook_01.tpc                                      
                             cook_01.tsc                                      
                             cook_01.tsp                                      
                             cook_02.tc                                       
                             cook_02.tsp                                      
                             sptest.gen                                       
                             sptest.rqs                                       
                             sptest.tsp                                       
                                                                              
                                                                              
Using the NAIF Toolkit                                                        
===========================================================================   
                                                                              
     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   
     (./naif/toolkit/src/cookbook/*.main) 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, manipulate the comments in binary SPK    
     and CK files, 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 ./naif/toolkit/doc and have 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.   *.for, *.f                                                      
                                                                              
              Fortran-77 source code files.                                   
                                                                              
         2.   *.main                                                          
                                                                              
              Source code files for program modules.                          
                                                                              
         3.   *.inc                                                           
                                                                              
              Fortran-77 include files.                                       
                                                                              
         4.   *.c                                                             
                                                                              
              C source code files.                                            
                                                                              
         5.   *.o                                                             
                                                                              
              Unix object files.                                              
                                                                              
         6.   *.obj                                                           
                                                                              
              VAX/VMS object files.                                           
                                                                              
         7.   *.a                                                             
                                                                              
              Unix object library files.                                      
                                                                              
         8.   *.olb                                                           
                                                                              
              VAX/VMS object library files.                                   
                                                                              
         9.   *.tsp                                                           
                                                                              
              Transfer format SPK (ephemeris) files.                          
                                                                              
        10.   *.bsp                                                           
                                                                              
              Binary format SPK (ephemeris) files.                            
                                                                              
        11.   *.tc                                                            
                                                                              
              Transfer format CK (pointing) files.                            
                                                                              
        12.   *.bc                                                            
                                                                              
              Binary format CK (pointing) files.                              
                                                                              
        13.   *.ti                                                            
                                                                              
              Text IK (instrument parameters) files.                          
                                                                              
        14.   *.tls                                                           
                                                                              
              Leapseconds kernel files.                                       
                                                                              
        15.   *.tpc                                                           
                                                                              
              Physical and cartographic constants kernel files.               
                                                                              
        16.   *.tsc                                                           
                                                                              
              Spacecraft clock coefficients kernel files.                     
                                                                              
        17.   *.txt                                                           
                                                                              
              Text format documentation files.                                
                                                                              
        18.   *.ug                                                            
                                                                              
              Text format User's Guides.                                      
                                                                              
        19.   *.req                                                           
                                                                              
              Text format SPICELIB Required Reading files.                    
                                                                              
        20.   make_toolkit.csh, build_it.csh                                  
                                                                              
              Unix C shell script files for creating the toolkit object       
              libraries and executables.                                      
                                                                              
        21.   make_toolkit.sh, build_it.sh                                    
                                                                              
              Unix Bourne shell script files for creating the toolkit         
              object libraries and executables.                               
                                                                              
        22.   (product name)                                                  
                                                                              
              Unix executable files. For example, spacit is the executable    
              file for the product spacit.                                    
                                                                              
        23.   make_(product name).com                                         
                                                                              
              VAX/VMS command procedures for creating products. For           
              example, make_spicelib.com creates the object library           
              spicelib.olb, while make_spacit.com creates the executable      
              spacit.exe.                                                     
                                                                              
        24.   (product name).exe                                              
                                                                              
              VAX/VMS executable files. For example, spacit.exe 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.