Ufiles Related Modules
	======================

These modules are available through the NTCC Webpage,
w3.pppl.gov/NTTC  under "Modules Library", as compressed
tarfiles, <name>.tar.gz, and as zip archives, <name>.zip.
Alternatively they can be obtained from ftp.pppl.gov
in pub/NTCC/.


****************
REVISION HISTORY
****************
      date         Description

  May 15, 1999  -- portability upgrade -- use portlib.a
                   MDS+ data access option via mdstransp module
                   Ufiles and TrGraf REAL*8 interface routines added.

  Oct 01, 2001  -- Use Makefiles instead of TRANSP generated scripts.

******************
    MODULES
******************

Note: Installation Notes for Uread, Ufiles, TrGraf and 
      PPPL_Utilities Modules are common in INSTALL, included in each
      "<module>.{tar.gz,zip}" archive. 
      Installation notes for Sglib and XtcTek are separate in 
      README_sglib and README_xtctek included in the modules. 
     

   MODULE
   ------      

   UREAD   	 --	Terminal control/interactive program automation.

   UFILES	 --	Standard for storing physics data.

   TRGRAF	 --	Interactive Data Display Library.

   PPL_UTILITIES --	Tools to study and analyze experimantal data.
			concat       -- Ufiles concatenator tool
			extrac       -- Ufiles extractor tool
			gaver{0,1,2} -- Ufile averaging utility
			gsmoo{0,1,2} -- smoothing/units conversion
			propane      -- generate Ufiles from hand entered
					 data for TRANSP input
			sawtoo	     -- Ufile sawtooth analyzer
			splice{2}    -- Ufiles splice utility
			thin{1,2}    -- Ufile thinning utility
			ugraf{1,2}   -- Ufiles display programs
			ulook0       -- scalar Ufile display program

   SGLIB	 --	Scientific Graphics Library.
			xplot        -- SGLIB output file plotting routine

   XtcTek	 --	Xtc	     -- X-windows Tektronix Controller.
			                (needs Motif)
			tek2ps	     -- convert tektronix to PS format.
		

Contents of Archives:
---------------------

All modules contain:

README:         This file.  Brief descriptions of the other files, and
                instructions for compiling, testing and installing the
                libraries and utilities.

INSTALL:	Detailed instructions how to build the libraries.

Makefile:       NOTE, "GNU make" must be used
                (usually in /usr/gnu/bin or /usr/local/bin).
                Main Makefile to envoke Makefile(s) in subdirectories.  


-- in subdirectory share:
   Make.flags:        Include file for Makefile, to setup Flags, etc.
   Make.local.sample: Include file for Makefile, to setup non-conventional,
                      site specific locations.

-- in subdirectory fpreproc:
   Python scripts for fortran pre-processing:

-- in subdirectory include/fpreproc:
   *.h files for source pre-processing.

-- the following subdirectories contain Makefile and sources to build
	 internally used libraries:

	- portlib       -- portability routines
	- sgdummy       -- stubs for sglib
	- vaxonly       -- miscellanious
	- generic_dummy -- stubs for netCDF, HDF and MDSplus libraries

-- in subdirectory test:
   demo input files for testing. 
 
The individual modules contain the following subdirectories with Makefile
and sources:

   Module      subdirectory	

   uread	ureadsub 	-- i/o command interface
  		 - nulltron	-- test program
		

   ufiles	uflib		-- Ufiles i/o subroutine library
		 - uftype	-- program
	   	mdspro 		-- IDL functions to read/write Ufiles 
	   	mdstransp	-- MDSplus interface       
		ufhdf	        -- netCDF/HDF interface
                ureadsub        -- i/o command interface

   trgraf	trgraf		-- display routines
		 - tgtest	-- test program for trgraf
		ureadsub	-- i/o command interface
		sglib		--  graphics library
	
   uutil	util		-- PPPL  utilities 
		test 		-- demo scripts for each utility
		concat_sub	-- for concat
		extrac_sub	-- for extrac
		rngsel_sub	-- old control routines for Ufiles
		sawcor_sub	-- for sawtoo
		thinsub		-- for thin*
		smlib		-- for smoothing
	  	interp_sub	-- linear or bilinear interpolation
                ureadsub	-- i/o command interface
		uflib 		-- Ufiles i/o subroutine library
		ufhdf		-- netCDF/HDF interface
		mdstransp	-- MDSplus interface 
	        trgraf		-- display routines
		sglib		-- graphics library

		(a description of the demo scripts can be found
                 under the Ufiles help at

                     http://w3.pppl.gov/~pshare/help/ufiles.htm

                 see the section on utilities).

----------------------------------------------------------------------

   sglib	- README
		- Makefile         
		  sglib		-- graphics libraries (sg and jc)
		  - xplot	-- program to view a sglib plot file
		  - various test programs 

   xtctek   	- README
		- Makefile
		- sources for xtc
		- sources for tek2ps


Detailed information of each module is provided in 
http://w3.pppl.gov/NTCC/Ufiles


*************************
Installation Instructions
*************************
 
For Ufiles related modules see INSTALL provided with the archives.

For SGLIB (standalone) see ./sglib/README.
For XtcTek see ./xtctek/README.


IF YOU HAVE ANY PROBLEMS, PLEASE CONTACT:


        transp_support, Princeton University
                transp_support@pppl.gov