home *** CD-ROM | disk | FTP | other *** search
/ Photo CD Demo 1 / Demo.bin / hdf / readme.fir < prev    next >
Text File  |  1980-02-06  |  11KB  |  251 lines
  1. #***************************************************************************
  2. #
  3. #
  4. #                         NCSA HDF version 3.2
  5. #                            August 28, 1992
  6. #
  7. # NCSA HDF Version 3.2 source code and documentation are in the public
  8. # domain.  Specifically, we give to the public domain all rights for future
  9. # licensing of the source code, all resale rights, and all publishing rights.
  10. #
  11. # We ask, but do not require, that the following message be included in all
  12. # derived works:
  13. #
  14. # Portions developed at the National Center for Supercomputing Applications at
  15. # the University of Illinois at Urbana-Champaign, in collaboration with the
  16. # Information Technology Institute of Singapore.
  17. #
  18. # THE UNIVERSITY OF ILLINOIS GIVES NO WARRANTY, EXPRESSED OR IMPLIED, FOR THE
  19. # SOFTWARE AND/OR DOCUMENTATION PROVIDED, INCLUDING, WITHOUT LIMITATION,
  20. # WARRANTY OF MERCHANTABILITY AND WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE
  21. #
  22. #***************************************************************************
  23.  
  24. NCSA HDF is the Hierarchical Data Format, a standard file format
  25. developed by NCSA. This document describes:
  26.  
  27.      Routines included in the current release of HDF; 
  28.      Platforms supported by the current release; 
  29.      Obtaining a version of HDF for your system; and 
  30.       Obtaining HDF documentations. 
  31.  
  32. Other information, including hints on using HDF, and instructions 
  33. on how to to create a library, can be found in other README files 
  34. in this directory.
  35.  
  36. For more information about HDF, see the document "NCSA HDF Calling 
  37. Interfaces and Utilities", the document "HDF Specification" and 
  38. "NCSA HDF Vset".
  39.  
  40. If you have any questions, problems, bug reports or suggestions, 
  41. you can contact us via Email at sxu@ncsa.uiuc.edu,  or by writing 
  42. to HDF, Software Tools Group, NCSA, 605 East Springfield Ave., 
  43. Champaign, IL 61820, or call (217) 244-0647.
  44.  
  45.  
  46. ************************************************************************
  47. Routines included in HDF3.2r1.
  48. ************************************************************************
  49.  
  50. This is NCSA HDF version 3.2 release 1. Included in this version are:
  51.  
  52.     the basic low-level routines to perform I/O to HDF files, 
  53.     routines to process 8-bit Raster Image Sets
  54.     routines to process Scientific Data Sets.
  55.     routines to process 24-bit Raster Image Sets
  56.     routines to process Palettes (independently of images)
  57.     routines to process Annotations for data items
  58.         routines to process Vsets.
  59.  
  60.  
  61. ************************************************************************
  62. Platforms supported by HDF3.2r1.
  63. ************************************************************************
  64.  
  65. This version of HDF runs on the following platforms:
  66.  
  67.         Platform        Machine Type
  68.         --------        ------------
  69.         Sun-4           SUN
  70.         Cray-2          UNICOS
  71.         Cray-Y/MP       UNICOS
  72.         Convex          CONVEX
  73.         SGI Iris 4D     IRIS4
  74.         IBM RS/6000     IBM6000
  75.         DECstation 3100 MIPSEL
  76.         DECstation 5000 MIPSEL
  77.         Vax/VMS         VMS
  78.         HP 9000         HP9000
  79.         Macintosh       MAC
  80.         IBM PC/clone    PC
  81.         NeXT            NEXT
  82.         CONVEX          CONVEXNATIVE
  83.  
  84. Compilation of these programs produces a library of HDF routines that 
  85. can be called from either FORTRAN or C programs.
  86.  
  87.  
  88. ************************************************************************
  89.     Obtaining HDF using anonymous ftp
  90. ************************************************************************
  91.  
  92. HDF3.2r1 is available on the NCSA anonymous ftp server
  93. (ftp.ncsa.uiuc.edu, IP address 141.142.20.50) in the
  94. directory HDF/HDF3.2r1.  This directory  contains
  95. the following:
  96.  
  97.     this file "README.FIRST" 
  98.  
  99.     the file "README.VMS" which explains how to use the utility
  100.     FIXATR to convert files between different formats on VMS.
  101.  
  102.     the file "README.IBMPC" which lists system requirement for
  103.     installation of HDF3.2r2 on IBMPC.
  104.  
  105.     the file "README.NCSA" which describes where HDF is installed 
  106.     on various platforms at NCSA.
  107.  
  108.     the file "MigrationNotes" with documentation of the
  109.     differences between HDF 3.1 and HDF 3.2, and implications
  110.     of these differences for writing programs that use HDF.
  111.  
  112.     the file "CODECHANGES" which lists code changes made  
  113.     since HDF3.2r1.
  114.  
  115.     makefiles for several of the supported platforms, plus a
  116.     generic "Makefile.template". The makefile for IBM/PC is
  117.     the subdirectory src/makepc.msc. 
  118.  
  119.     an INSTALL.TOP file that explains how to use a makefile to
  120.     install all or any part of HDF.
  121.  
  122.     a "src" directory with only the source modules for
  123.     the HDF library.
  124.   
  125.     a "test" directory containing the test suite.
  126.  
  127.     a "bkwdtest" directory containing the programs and hdf files 
  128.       to test the compatibility of HDF3.2r2.
  129.  
  130.     a "util" directory containing the utilities.
  131.     
  132.     a "examples" directory containing the example data/hdf files
  133.       which can be used to test the utilities.
  134.  
  135.     a "doc" directory containing HDF documentations.
  136.  
  137. The HDF/tarHDF3.2r1 directory contains a collection of compressed
  138.     tar files, which together contain the entire HDF 3.2r1
  139.     release. This directory contains a file "README.NOW"
  140.     that explains how to process the compressed tar files.
  141.  
  142.  
  143. To download HDF from NCSA anonymous ftp server, you need to
  144. login to ftp.ncsa.uiuc.edu (141.142.20.50), with a login name of 
  145. "anonymous". Give your real name as password.  Move to the directory 
  146. "HDF" by issuing the command "cd HDF" to ftp.  Now you are ready to 
  147. transfer files.  There are two ways to do this:
  148.  
  149. 1. You may use the command "mget hdf3.2r1.tar.Z*" to download a compressed
  150. "tar" format file, then concatenate them in your directory with the Unix
  151. command "cat hdf3.2r1.tar.Z* > hdf3.2r1.tar.Z".  Be sure to set file transfer
  152. mode to binary with the command "binary".  (NOTE: this tar file is very
  153. large, as it contains all the source files, plus all of the documentation. 
  154. If space is dear, consider using the method described in paragraph 2.)
  155.  
  156. Uncompress and detar this file with the Unix commands 
  157. "uncompress hdf3.2r1.tar" and "tar xvf hdf3.2r1.tar". This produces 
  158. a tree of subdirectories similar to the ones in this directory.    
  159.  
  160. These files are described in the files INSTALL.TOP , which is in the 
  161. same directory, and INSTALL in the subdirectory src.  They must be 
  162. compiled according to the instructions in those files.  
  163.  
  164. 1a) For MacII/MPW users, HDF3.2r1 currently supports C interface only on
  165. Macintosh. For users who need Fortran support, there is a binhexed 
  166. stuffit file called Spyglass3.1.sit.hqx which contains HDF3.1r3 binary
  167. code and README files for Mac. It is in the directory 
  168. ftp/HDF/prev_releases. Use ascii mode to get this file, unbinhex it, 
  169. then unstuff it. This will provide you will all the files for the MacII.
  170.  
  171. 2. As an alternative to "tar", you may download the files you require 
  172. directly.  Use "cd src" to move to the directory containing source 
  173. files.  Then use the command "mget *". If your system is VMS, get the
  174. files in util/fixatr also.  This will prompt you for each
  175. of the source files, asking if you want to download them. Answer "y" to each.
  176. This will produce the source files for that system in your directory. 
  177. Compile these files according to the instructions in the file INSTALL.
  178.  
  179.  
  180. **********************************************************************
  181.                    Obtaining HDF documentation 
  182. **********************************************************************
  183.  
  184. Hardcopy versions of the documetation can be purchased from NCSA.  To
  185. obtain a catalog, contact:
  186.  
  187. NCSA Documentation Orders
  188. 152 Computing Applications Building
  189. 605 E. Springfield Ave.
  190. Champaign, IL 61820
  191.  
  192. (217) 244-0072  
  193.  
  194.  
  195. To obtain the documentations enter "cd doc".  There are three
  196. subdirectories, HDF3.1 -- containing the user documentation (NCSA HDF
  197. Calling Interfaces and Utilities), HDF.Specs -- containing the 
  198. technical specification (NCSA HDF Specifications), and HDF.Vset2.0
  199. -- containing Vset documentation (NCSA HDF Vset), respectively. Under
  200. each subdirectory there are three forms of the documentation, 
  201. one ASCII, one PostScript, and one in Macintosh Microsoft Word format.  
  202. In the doc directory there is also an hdf.man -- the manpage for HDF, and
  203. an  ASCII file named  vset2.1.extra.doc, which can be regraded as a supplement
  204. to the documentations for HDFVset2.0. 
  205.  
  206. The ASCII form of the user documentation is in doc/HDF3.1/HDF.ascii/. 
  207. This version was created by saving the MS Word version as text, 
  208. so it is quite crude and has no formatting or illustrations.
  209. The ascii files may be downloaded in ascii mode.
  210.  
  211. The PostScript version of the documentation is in doc/HDF3.1/HDF.postscript.
  212.  
  213. The Macintosh Microsoft Word files are stored in doc/HDF3.1/HDF3.1.msw.sit.hqx.
  214. It is a binhexed stuffit file, which can be transmitted in ascii mode.  Use
  215. ascii mode to get this file, unbinhex it, then unstuff it.
  216.  
  217. The Microsoft Word files are in Microsoft Word 4.0 format.  This
  218. is the format used to print the hard copy versions distributed by
  219. NCSA.  If you do not have MS Word 4.0, you will probably not be able
  220. to print the documents in these files.  MS Word 3.0, for instance, does not
  221. correctly print these files.
  222.  
  223. Similarly, there is an ASCII version of HDF Specification in 
  224. doc/HDF.Specs/HDFSpecs.asc.tar; a MicroSoft Word version in 
  225. doc/HDF.Specs/HDFSpecs.msw.sit.hqx; and a PostScript version
  226. in doc/HDF.Specs/HDFSpecs.postscript/.
  227.  
  228. The ASCII, PostScript and MSW versions of HDF Vset documentation are
  229. in doc/HDF.Vset2.0/HDFVset/ascii/, doc/HDF.Vset2.0/HDFVset.postscript/
  230. and doc/HDF.Vset2.0/HDFVset.msw/sit.hqx, respectively.
  231.  
  232. ***********************************************************************
  233. * If you want to see more software like NCSA HDF, you need to send us a 
  234. * letter, email or US mail, telling us what you are doing with NCSA HDF. 
  235. * We need to know: 
  236. * 1) What science you are working on (an abstract of your work would be 
  237. * fine); 
  238. * 2) How NCSA HDF has helped you, e.g., whether it has increased your 
  239. * productivity or allowed you to perform operations you were unable to 
  240. * do before. 
  241. *  
  242. * We encourage you to cite the use of NCSA HDF , and any other NCSA 
  243. * software you have used, in your publications.  A bibliography of your 
  244. * work would be extremely helpful. 
  245. *  
  246. * This is a new kind of shareware.  You share your science and successes
  247. * with us, and we attain the resources necessary to share more software 
  248. * like NCSA HDF with you. 
  249. * 
  250. ***********************************************************************
  251.