next up previous FTOOLS Home
Next: Task Design Up: Developer's Guide Previous: FTOOLS Software Style

Package Directory Structure

The FTOOLS package directory structure models closely the directory structure used by external packages in IRAF. This consists of a top level directory ftools/ which contains subdirectories

  • bin, bin.generic, and bin.sparc or bin.ssun - directories for iraf binaries and support.
  • asca/ - sub-package directory
  • caltools/ - sub-package directory
  • einstein/ - sub-package directory
  • fimage/ - sub-package directory
  • futils/ - sub-package directory
  • gro/ - sub-package directory
  • heasarc/ - sub-package directory
  • rosat/ - sub-package directory
  • time/ - sub-package directory
  • vela5b/ - sub-package directory
  • xronos/ - sub-package directory
  • xte/ - sub-package directory
  • examples/ - an example package for FTOOLS; contains the source used in the coming examples.
  • fitsio/ - the source for Bill Pence's FITSIO library along with the make files needed to build the library in both the Host and IRAF environments.
  • cfitsio/ - the new C version of the fitsio package.
  • library/ - a set of source files and build files for various FTOOLS related libraries.
  • lib/ - IRAF related files; system specific mkpkg files.
  • host/ - configuration and top-level Makefiles; location of libraries for host build.
  • include/ - header files for various libraries.
  • help/ - help pages for the host version; copied from package directories at build time.
  • testdata/ - sample FITS files for use in testing the package installation.
  • refdata/ - calibration data for several of the mission specific FTOOLS.
  • scripts/ - useful example scripts that have been provided by the users of FTOOLS.
  • xselect/ - source code for XSELECT and the EXTRACTOR.
  • tcltk/ - source code for tcl/tk package and the GUI tasks such as fv.

The top level ftools/ directory also contains the files ftools.cl, ftools.hd, ftools.men and ftools.par used to define the package under IRAF and the IRAF mkpkg (make package) file for building FTOOLS.

The contents of the sub-package directories asca/, caltools/, einstein/, fimage/, futils/, heasarc/, gro/, rosat/, time/, vela5b/, xronos/ and xte/ closely parallel each other. They contain a doc/ subdirectory with the IRAF help pages, a help/ subdirectory with the original Host text help pages, which are copied during the build into a single ftools/ level help/ directory to provide a single path for the Host help task fhelp. Also found in each sub-package directory is a host subdirectory containing the host build files. Another IRAF lib/ subdirectory also exist at this level. The source files along with IRAF build files are located in the src/ subdirectory as mentioned above. There are also the files asca(caltools,...).cl, asca(caltools,...).hd, asca(caltools,...).men, asca(caltools,...).par and mkpkg necessary for defining the sub-packages.


next up previous FTOOLS Home
Next: Task Design Up: Developer's Guide Previous: FTOOLS Software Style

Web Page Maintained by: Dr. Lawrence E. Brown elwin@redshift.gsfc.nasa.gov

FTOOLS HELP DESK

If FTOOLS has been useful in your research, please reference this site (http://heasarc.gsfc.nasa.gov/ftools) and use the ASCL reference for HEASoft [ascl:1408.004] or the ASCL reference for the original FTOOLs paper [ascl:9912.002]:

Blackburn, J. K. 1995, in ASP Conf. Ser., Vol. 77, Astronomical Data Analysis Software and Systems IV, ed. R. A. Shaw, H. E. Payne, and J. J. E. Hayes (San Francisco: ASP), 367.

Web page maintained by: Bryan K. Irby