1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
|
Copyright (C) 1996 Hughes and Applied Research Corporation
Permission to use, modify, and distribute this software and its documentation
for any purpose without fee is hereby granted, provided that the above
copyright notice appear in all copies and that both that copyright notice and
this permission notice appear in supporting documentation.
#-----------------------------------------------------------------------------
# filename:
# README
#
# description:
# Installation instructions for HDFEOS5
#
# author:
# Mike Sucher / Applied Research Corp.
#
# history:
# 18-Jun-1996 MES Initial version
# 10-Apr-1997 DaW Updated for Release B0
# 29-Oct-1997 DaW Updated for Release 2.1
# 23-Mar-1998 MEDS Updated for Release 2.2
# 16-Jun-1998 MEDS Updated for Release 2.3
# 27-Aug-1998 MEDS Updated for Release 2.4
# 9-Nov-2000 DaW Updated for Beta-2 Release 5.0
# 30-Oct-2002 Phuong Nguyen - Updated for Release 5.1.3
# 10-Oct-2007 Abe Taaheri - Updated for Release 5.1.11
# 10-Jun-2009 Abe Taaheri - Updated for Release 5.1.12
# 19-Aug-2010 Abe Taaheri - Updated for Release 5.1.13
#
#-----------------------------------------------------------------------------
Contents
========
Installation Instructions
Preliminary
Unpacking the distribution file
Starting the installation procedure
User Account Setup
File Cleanup
Compiling and Linking with HDFEOS
Notes
Approved platforms
Architecture type names
Directory and file environment variables
Other environment variables
Copyright notice for cfortran.h
Installation Instructions
=========================
Preliminary
-----------
Before installing HDFEOS, you must already have installed HDF5,
version 1.8.5, on your host. The installation script will prompt
for the paths to the HDF5 include and library directories.You also may
need to install zlib-1.2.5, szip-2.1, and jpeg.v6b.
Unpacking the distribution file
-------------------------------
1) Select a location for the HDFEOS5 directory tree. Installing
HDFEOS5 alone requires a disk partition with at least 35 Mb
of free space.
2) Copy the file HDF-EOS5.1.13.tar.Z to the target directory by
typing the command:
cp HDF-EOS5.1.13.tar.Z <target-dir>
where <target-dir> is the full pathname of your target directory.
3) Set your default directory to the target directory by typing
the command:
cd <target-dir>
4) Uncompress this file and extract the contents by typing the command:
zcat HDF-EOS5.1.13.tar.Z | tar xvf -
This will create a subdirectory of the current directory
called 'hdfeos5'. This is the top-level HDFEOS directory,
which contains the full HDFEOS directory structure.
Starting the installation procedure
-----------------------------------
1) Set your default directory to the top-level HDFEOS directory by
typing the command:
cd hdfeos5
2) Select installation options.Please note that cuurent version of
HDF-EOS5 is not supported in SGI since HDF5-1.8.5 does not support it.
The following instruction concerning SGI are only for previous
versions od HDF5 and HDF-EOS5.
Currently, the only options are those specific to the SGI Power
Challenge platform.
On the SGI Power Challenge, the default is to build HDFEOS in
64-bit mode. The following table gives the option
to specify the appropriate architecture to be built:
binary format architecture <install-options>
------------- ------------ ---------------
new-style 32 bit sgi32 -sgi32
64 bit sgi64 <default>
Please note that the old-32-bit mode has been dropped as the default
because it is no longer being supported by SGI, it is therefore
recommended that all users migrate to new-style 32 bit or 64 bit mode.
3) Run the installation script.
Please note that the installation script for this release of
HDFEOS requires user interaction. Because of this, it should NOT
be run as a background task.
3.0) (optional)
If you wish to generate a log of this session, use the Unix
'script' command. This command runs a sub-shell that saves
all terminal output to the specified file.
To log the session, type:
script <logfile-name>
where <logfile-name> is the name of the log file.
3.1)
To run the installation script, type the command:
bin/INSTALL-HDFEOS <install-options>
where <install-options> is the list of options determined in
the previous step.
The installation script will then run. It will output various
startup messages, beginning with:
HDFEOS installation starting at <date/time>
3.2)
Enter the full pathnames for the HDF5 library and include
directory paths, when the script prompts for them. If there
is an error in the supplied paths, the script will exit.
NOTE:
If the environment variables HDFLIB and/or HDFINC are set
in your shell, the script will use these for the default values.
If this is not the first run of the script, the default values
will be taken from the values used for the last run of the script.
In either of these cases, the installation script will prompt with:
Current value of the HDF library directory is: <path>
Accept [y]/n:
and/or
Current value of the HDF include directory is: <path>
Accept [y]/n:
Make sure to type 'n' and hit return, if the defaults do not
point to the correct directories. The script will then prompt
for the new values.
3.3)
The installation script will finish with the following message:
HDFEOS installation ending at <date/time>
3.4) (optional - see 3.0)
If you ran the Unix 'script' command to create a log file, then
type 'exit' and hit return at the command prompt. This will
exit the sub-shell stated by 'script' and save the log file.
HINT:
The log file generated by the script command may contain 'hard
return' characters at the end of each line. These appear in
some text editors as "^M". They can be removed with the
following command:
sed 's/.$//' <logfile-name> > <logfile-name>.new
where <logfile-name> is the name of the log file.
User Account Setup
------------------
Once HDFEOS5 has been installed, the accounts of HDFEOS5 users
must be set up to define environment variables needed to compile and
run code with HDFEOS (see parts 2 and 3 of the Notes section, below).
The type of setup depends on the user's login shell.
1A) C shell (csh) users:
Edit the HDFEOS5 user's .cshrc file to include the
following line:
source <HDFEOS5-home-dir>/bin/$BRAND/hdfeos_env.csh
where <HDFEOS5-home-dir> is the full path of the HDFEOS5 home
directory, and $BRAND is an architecture-specific value for
your host. Please refer to part 2 of the Notes section,
below, to determine the correct value.
The script hdfeos_env.csh sets up all the variables discussed in
parts 2 and 3 of the Notes section, below, and it adds the HDFEOS
bin directory to the user path.
The environment variables will become available during all
subsequent login sessions. To activate them for the current
session, simply type one of the two lines listed above, at the
Unix prompt.
Note regarding path setup with hdfeos_env.csh
----------------------------------------------
The script hdfeos_env.csh also makes available a variable
called hdfeos_path. This can be added to the user's path to
ensure that it accesses the directories necessary for the
compilers and other utilities used to generate executable
programs. It is not added to the user path by default,
because in many cases it adds unnecessary complexity to
the user path. To add hdfeos_path to the user path, modify
the HDFEOS user's .cshrc file to include the following:
set my_path = ($path) # save path
source <HDFEOS5-HOME-DIR>/bin/$BRAND/hdfeos_env.csh # HDFEOS5 setup
set path = ($my_path $hdfeos_path) # add hdfeos_path
INSTEAD OF the line listed at the beginning of this step.
Note that it is the user's responsibility to set up
his or her own path so that it doesn't duplicate the
directories set up in hdfeos_path. Please also note that the
hdfeos_path is added AFTER the user's path. This way, the
user's directories will be searched first when running Unix
commands.
1B) Korn shell (ksh) users:
Edit the HDFEOS5 user's .profile file to include the following line:
. <HDFEOS5-home-dir>/bin/$BRAND/hdfeos_env.ksh
where <HDFEOS5-home-dir> is the full path of the HDFEOS home
directory, and $BRAND is an architecture-specific value for
your host. Please refer to part 2 of the Notes section,
below, to determine the correct value.
The script hdfeos_env.ksh sets up all the variables discussed in
part 2 and 3 of the Notes section, below, and it adds the HDFEOS
bin directory to the user path.
The environment variables will become available during all
subsequent login sessions. To activate them for the current
session, simply type one of the two lines listed above, at the
Unix prompt.
Note regarding path setup with hdfeos_env.ksh
----------------------------------------------
The script hdfeos_env.ksh also makes available a variable
called hdfeos_path. This can be added to the user's path to
ensure that it accesses the directories necessary for the
compilers and other utilities used to generate executable
programs. It is not added to the user path by default,
because in many cases it adds unnecessary complexity to
the user path. To add hdfeos_path to the user path, modify
the HDFEOS user's .profile file to include the following:
my_path="$PATH" # save path
. <HDFEOS5-HOME-DIR>/bin/$BRAND/hdfeos_env.ksh # HDFEOS5 setup
PATH="$my_path:$hdfeos_path" ; export PATH # add hdfeos_path
INSTEAD OF the line listed at the beginning of this step.
Note that it is the user's responsibility to set up
his or her own path so that it doesn't duplicate the
directories set up in hdfeos_path. Please also note that the
hdfeos_path is added AFTER the user's path. This way, the
user's directories will be searched first when running Unix
commands.
1C) Bourne shell (sh) users:
Set up the required HDFEOS5 environment variables by appending
the contents of the file <HDFEOS5-home-dir>/bin/$BRAND/hdfeos_env.ksh
to the end of the HDFEOS5 user's .profile, where <HDFEOS5-home-dir>
is the full path of the HDFEOS home directory, and $BRAND is an
architecture-specific value for your host. Please refer to part
2 of the Notes section, below, to determine the correct value.
The environment variables will become available during all
subsequent login sessions. To activate them, log out and
then log back in.
File Cleanup
------------
Once HDFEOS has been built and tested, you can delete certain
temporary files and directories to save some disk space. Note
that once these files have been removed, you will need to unpack
the original distribution file in order to re-do the installation.
To remove these files:
cd <HDFEOS5-home-dir>/bin
rm -rf tmp
cd <HDFEOS5-home-dir>/lib
rm -rf tmp
Compiling and Linking with HDFEOS
---------------------------------
In order to compile and link programs with the HDFEOS you must
access the HDFEOS include and library files. To do this be
sure that your makefiles include something like the following:
INCLUDE = -I. -I$(HDFEOS_INC) -I$(HDFINC)
LIBRARY = -L. -L$(HDFEOS_LIB) -L$(HDFLIB)
LDFLAGS = -lhe5_hdfeos -lGctp -lhdf5_hl -lhdf5 -lnsl -ljpeg -lz -lsz -lm (Sun platform)
LDFLAGS = -lhe5_hdfeos -lGctp -lhdf5_hl -lhdf5 -ljpeg -lz -lsz -lm (others)
The environment variables HDFEOS_INC, HDFEOS_LIB, HDFINC and HDFLIB
are set up by the HDFEOS environment scripts (see User Setup, above).
They refer to the include and library directories for HDFEOS and HDF,
respectively.
The INCLUDE macro should be included in all compilation statements.
The LIBRARY an LDFLAGS macros should be included in all link statements.
Notes
=====
1) Approved platforms
HDFEOS5 was built and tested in a multi-platform environment.
The list of approved platforms, which includes information about
operating system and compiler versions, may be found in the
HDFEOS User's Guide.
2) Architecture type names
To track architecture dependencies, HDFEOS defines the
environment variable $BRAND. Following is a list of valid values
for this variable, which is referred to throughout this document:
(we officially does not support some platforms startinfg with
HDF-EOS5.1.12, such as dec, hp, ibm, sgi, and sun5.8 and sun5.9 )
$BRAND Architecture
====== ============
dec* DEC Alpha
hp* HP 9000, HPUX-11 9000/785
ibm* IBM RS-6000
sgi* IRIX 5.3;6.2
sgi32* SGI Power Challenge (new-style 32-bit mode)
sgi64* SGI Power Challenge (64-bit mode)
sun5.X Sun: SunOS 5.x (5.8*,5.9*,5.10)
linux Linux: Red Hat Enterprise
linux32 64-bit linux platform in 32-bit mode
linux64 64-bit linux platform in 64-bit mode
macintosh Darwin6.8
macintel Darwin, Intel i386
Windows Windows XP: Microsoft Visual C++ 2008
cygwin i686 cygwin
* These platforms are not officially supported anymore
3) Directory and file environment variables
In order to use the HDFEOS libraries and utilities, a number of
environment variables MUST be set up to point to HDFEOS directories
and files. These variables are automatically set up in User Account
Setup section of the installation instructions. They are
listed here for reference:
name value description
==== ===== ===========
HDFEOS5_HOME <install-path>/hdfeos top-level directory
(where <install-path> is the absolute directory path above hdfeos)
HDFEOS5_BIN $HDFEOS5_HOME/bin/$BRAND executable files
HDFEOS5_INC $HDFEOS5_HOME/include header files
HDFEOS5_LIB $HDFEOS5_HOME/lib/$BRAND library files
HDFEOS5_OBJ $HDFEOS5_HOME/obj/$BRAND object files
HDFEOS5_SRC $HDFEOS5_HOME/src source files
4) Other environment variables
In addition, the makefiles which are used to build the libraries
require certain machine-specific environment variables. These set
compilers, compilation flags and libraries, allowing a single set of
makefiles to serve on multiple platforms. The User Account Setup
section of the installation instructions explains how to set them up.
They are listed here for reference:
name description
==== ===========
CC C compiler
CFLAGS default C flags (optimize, ANSI)
C_CFH C w/ cfortran.h callable from FORTRAN
CFHFLAGS CFLAGS + C_CFH
C_F77_CFH C w/ cfortran.h calling FORTRAN
C_F77_LIB FORTRAN lib called by C main
F77 FORTRAN compiler
F77FLAGS common FORTRAN flags
F77_CFH FORTRAN callable from C w/ cfortran.h
F77_C_CFH FORTRAN calling C w/ cfortran.h
CFH_F77 same as F77_C_CFH
F77_C_LIB C lib called by FORTRAN main
5) Tools provided with this release
For a complete list of the tools provided with this release of
HDFEOS5, please refer to HDFEOS5 User's Guide.
6) Copyright notice for cfortran.h
The majority of the HDFEOS functions are written in C.
These C-based tools include the file cfortran.h, using it to
generate machine-independent FORTRAN bindings. The cfortran.h
facility includes the following notice which must accompany
distributions that use it:
THIS PACKAGE, I.E. CFORTRAN.H, THIS DOCUMENT, AND THE CFORTRAN.H EXAMPLE
PROGRAMS ARE PROPERTY OF THE AUTHOR WHO RESERVES ALL RIGHTS. THIS PACKAGE AND
THE CODE IT PRODUCES MAY BE FREELY DISTRIBUTED WITHOUT FEES, SUBJECT TO THE
FOLLOWING RESTRICTIONS:
- YOU MUST ACCOMPANY ANY COPIES OR DISTRIBUTION WITH THIS (UNALTERED) NOTICE.
- YOU MAY NOT RECEIVE MONEY FOR THE DISTRIBUTION OR FOR ITS MEDIA
(E.G. TAPE, DISK, COMPUTER, PAPER.)
- YOU MAY NOT PREVENT OTHERS FROM COPYING IT FREELY.
- YOU MAY NOT DISTRIBUTE MODIFIED VERSIONS WITHOUT CLEARLY DOCUMENTING YOUR
CHANGES AND NOTIFYING THE AUTHOR.
- YOU MAY NOT MISREPRESENTED THE ORIGIN OF THIS SOFTWARE, EITHER BY EXPLICIT
CLAIM OR BY OMISSION.
THE INTENT OF THE ABOVE TERMS IS TO ENSURE THAT THE CFORTRAN.H PACKAGE NOT BE
USED FOR PROFIT MAKING ACTIVITIES UNLESS SOME ROYALTY ARRANGEMENT IS ENTERED
INTO WITH ITS AUTHOR.
THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST
OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. THE AUTHOR IS NOT RESPONSIBLE
FOR ANY SUPPORT OR SERVICE OF THE CFORTRAN.H PACKAGE.
Burkhard Burow
burow@vxdesy.cern.ch
|
