summaryrefslogtreecommitdiffstats
path: root/INSTALL_Windows.txt
blob: 848ff85dff21315b81bda092fb44a0e7a1a0917f (plain)
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
HDF5 Install Instructions for Windows NT/95/98.
-------------------------------------------------------------------------

The instructions which follow assume that you will be using the the source
code release 'zip' file (hdf5-1_2_0.zip).

The following sections discuss in detail installation procedures. 

Building from Source Code Release (hdf5-1_2_0.zip)
===============================================

STEP I:  Preconditions

To build the HDF5 and tests, it is assumed that you have done the following:

      1. Installed MicroSoft Developer Studio, and Visual C++ 5.0 or 6.0.         

      2. Set up a directory structure to unpack the library. For 
      example: 
	    c:\					(any drive)
           MyHDFstuff\				(any folder name)

      3. Copied the source distribution archive to that directory 
      and unpacked it using the appropriate archiver options to
      create a directory hierarchy.
        
      Run WinZip on hdf5-1_2_0.zip (the entire source tree).
      This creates a directory called 'hdf5' which 
      contains several files and directories.


STEP II: Building the Libraries and tests.

        1. Unpack all.zip in 'hdf5'. 

        2. Invoke Microsoft Visual C++, go to "File" and select
           the "Open Workspace" option. 

           Then open the c:\myHDFstuff\hdf5\proj\all\all.dsw workspace. 

        3. Select "Build", then Select "Set Active Configuration".

           On Windows platform select as the active configuration

           "all -- Win32 Debug" to build debug versions of single-threaded
                                static libraries, and tests. 
            or

           "all -- Win32 Release" to build release versions of single-threaded
                                static libraries, and tests.

           Select "Build" and "Build all.exe" to
           build the corresponding version of the HDF5 library.

           NOTE: "all" is a dummy target. You will get a link error when   
           "all.exe." is built : 
                 LINK: error LNK2001: unresolved external symbol
			_mainCRTStartup.....
                 all.exe - 2 error(s), ....

           Warning messages can be ignored. The "all.exe" is never created, 
           so it is OK.

           When the debug or release build is done the directories listed 
           below will contain the following files :

            c:\MyHDFstuff\hdf5\proj\hdf5\debug - 
            c:\MyHDFstuff\hdf5\proj\hdf5\release - 

			hdf5.lib- the hdf5 library

           	c:\MyHDFstuff\hdf5\test\"test directory"-
            where test directory is one of the following:


			big

			bittests

			chunk

			cmpd_dset

			dsets

			dtypes

			extend

			external

			fillval

			flush1

			flush2

			gheap

			hyperslab

			iopipe

			istore

			links

			mount (not supported in this release)

			mtime

			overhead

			ragged 

			shtype 

			testhdf5 

			unlink 

Each test directory contains debug and release subdirectories with the 
corresponding tests.
		

STEP III:   TESTING THE BUILD



In a command prompt window run the test batch file which 
resides in the hdf5 directory to make sure that the library
was built correctly.

The hdf5testDBG.bat file tests the debug version of the library and 
hdf5testREL.bat tests the release version of the library.
 

        
STEP IV: BUILDING THE EXAMPLES

     1. Invoke Microsoft Visual C++, go to "File" and select
        the "Open Workspace" option. 
        Then open the c:\myHDFstuff\hdf5\examples\allexamples.dsw
        workspace. 

      2. Select "Build", then Select "Set Active Configuration".

         On Windows platform select as the active configuration
           "allexamples -- Win32 Debug" to build debug versions of the         					examples. 
            
		or
	
           "allexamples -- Win32 Release" to build release versions the            		examples.

           Select "Build" and "Build allexamples.exe" to
           build the corresponding version of the examples.

           When the debug build or release build is done there should be the 
           following subdirectories in C:\myHDFstuff\hdf5\examples\

			attributetest
 
			chunkread

			compoundtest 

			extendwritetest 

			grouptest 

			readtest 

			selecttest 

			writetest 



	3. Run the batch file "InstallExamples.bat" which resides in the top 	   level directory.  This file creates 2 new directories, examplesREL and         examplesDEB, in the examples directory and places all the executables in       it.  Both the release and debug versions of the examples should be built before this step is done.  The examples should be tested in these 2 new directories 
due to some dependencies between the examples.

			

STEP V:  

BUILDING AN APPLICATION USING THE HDF5 LIBRARY - SOME HELPFUL POINTERS
=====================================================================

If you are building an application that uses the HDF5 library 
the following locations will need to be specified for locating
header files and linking in the HDF libraries:

            <top-level HDF5 directory>\src

where <top-level HDF5 directory> may be 
    C:\MyHDFstuff\hdf5\



MORE HELPFUL POINTERS
=====================


Here are some notes that may be of help if you are not familiar
with using the Visual C++ Development Environment.

Project name and location issues: 
       
    The files in all.zip must end up in the hdf5\ directory
    installed by hdf5-1_2_0.zip

    If you must install all.dsw and all.dsp in another directory, relative 
    to hdf5\ , you will be asked to locate the sub-project files, 
    when you open the project all.dsw.

    If you want to rename all (the entire project), you will need to modify 
    two files all.dsw and all.dsp as text (contrary to the explicit warnings 
    in the files).

    You can also modify all.dsw and all.dsp as text, to allow these 2 files 
    to be installed in another directory.

  
Settings... details:

  	If you create your own project, the necessary settings can be
	read from the all.dsp file(as text), or from the Project Settings in 
	the Developer Studio project settings dialog.

    Project
	  Settings
	      C/C++
		  Category
		     PreProcessor
			 Code Generation
			    Use run-time Library
				   These are all set to use 
                                      Single-Threaded