updated top-level README and version_decl for V4.4.2 (#1795)
[WRF.git] / external / io_grib2 / g2lib / README
blobe60e4aec5cdc60798fbd9265545549a1dcd176ff
1                                                            Aug 21, 2003
2                                                            W/NP11:SAG
4 g2lib Library.
6 This library contains Fortran 90 decoder/encoder
7 routines for GRIB edition 2, as well as indexing/searching
8 utility routines.  The user API for the GRIB2 routines
9 is described in file "grib2.doc".
11 Some Fortran routines call "C" functions, which must
12 follow a specific symbol naming convention used by your
13 machine/loader to be linked successfully.
14 If you are having trouble linking to the C routines
15 in this library, please make sure the appropriate 
16 machine is defined as an option in the CFLAGS
17 variable in the makefile.  See the first few lines
18 of the makefile for valid options.
19 Recompile the library.
21 We have added support for PNG and JPEG2000 image compression
22 algorithms within the GRIB2 standard.  If you would like
23 to compile this library to utilize these GRIB2 Templates,
24 make sure that -DUSE_PNG and -DUSE_JPEG2000 are specified
25 in the FDEFS variable in the makefile.  You will also need
26 to download and install the external libraries listed below,
27 if they are not already installed on your system.
29 If you do not wish to bother with the external libs and
30 don't need PNG and JPEG2000 support, you can remove the
31 -DUSE_PNG and -DUSE_JPEG2000 flags from the FDEFS variable 
32 in the makefile.
35 -------------------------------------------------------------------------------
37      External Libraries:
39 libjasper.a - This library is a C implementation of the JPEG-2000 Part-1 
40               standard (i.e., ISO/IEC 15444-1).  This library is required
41               if JPEG2000 support in GRIB2 is desired.  If not, remove
42               the -DUSE_JPEG2000 option from the FDEFS variable 
43               in the makefile.
45               Download version jasper-1.700.2 from the JasPer Project's
46               home page, http://www.ece.uvic.ca/~mdadams/jasper/.
47         
48               More information about JPEG2000 can be found at 
49               http://www.jpeg.org/JPEG2000.html.
51 libpng.a      This library is a C implementation of the Portable Network
52               Graphics PNG image compression format.  This library is required
53               if PNG support in GRIB2 is desired.  If not, remove
54               the -DUSE_PNG option from the FDEFS variable
55               in the makefile.
57               If not already installed on your system, download version 
58               libpng-1.2.5 from http://www.libpng.org/pub/png/libpng.html.
60               More information about PNG can be found at 
61               http://www.libpng.org/pub/png/.
63 libz.a        This library contains compression/decompression routines
64               used by libpng.a for PNG image compression support. 
65               This library is required if PNG support in GRIB2 is desired.  
66               If not, remove the -DUSE_PNG option from the FDEFS variable
67               in g2lib/makefile.
69               If not already installed on your system, download version 
70               zlib-1.1.4 from http://www.gzip.org/zlib/.
72 -------------------------------------------------------------------------------
74 A note about routine MOVA2I:
76 Some routines in this library call subroutine MOVA2I, which is included in 
77 our W3LIB library containing the GRIB1 decoder/encoder routines.  If you
78 are using this library without libw3.a, you will need to compile mova2i.c 
79 (included in this distribution) so it can be added to libg2.a.  Just add
80 the line:
82         $(LIB)(mova2i.o) \
84 to the list of routines in the makefile.