From 5585643bb3643bbba7245b2c742e8008d8df5cfc Mon Sep 17 00:00:00 2001 From: MuQun Yang Date: Mon, 3 Mar 2003 11:17:07 -0500 Subject: [svn-r6449] Purpose: 1.update windows release doc related to the addition of semi-automatic generated H5Tinit.c project and workspace files. 2. Make the doc more clear. Description: 1. H5Tinit.c was manually maintained before and it might affect the users who wants to build and test from HDF5 snapshot release. 2. Make sure that we are supporting .Net only on XP and also emphasize to DLL users to the DLL critical section of the doc. Solution: 1. Add a section for those users to semi-auto generate H5Tinit.c. Platforms tested: Doc files, no need to test. Misc. update: --- release_docs/INSTALL_Windows.txt | 145 ++++++++++++++++++++++++++------------- 1 file changed, 99 insertions(+), 46 deletions(-) diff --git a/release_docs/INSTALL_Windows.txt b/release_docs/INSTALL_Windows.txt index 61487fd..0e66836 100644 --- a/release_docs/INSTALL_Windows.txt +++ b/release_docs/INSTALL_Windows.txt @@ -1,8 +1,8 @@ -HDF5 Build and Install Instructions for Windows 2000/NT/98. +HDF5 Build and Install Instructions for Windows 2000/XP. ---------------------------------------------------------- The instructions which follow assume that you will be using the -source code release 'zip' file (hdf5-1_4_3.zip). +source code release 'zip' file (hdf5-1_6_???.zip). ***************************WARNINGS**************************** Please read CAREFULLY about Preconditions before you go to the @@ -19,16 +19,23 @@ Preconditions c:\ (any drive) MyHDFstuff\ (any folder name) - 3. Run WinZip on hdf5-1_4_3.zip (the entire source tree) and - extract hdf5 package into c:\MyHDFstuff(or whatever drive - and folder name you would like to choose). This creates a - directory called 'hdf5xxx'under MyHDFstuff which contains - several files and directories. Rename the directory - "hdf5xxx" into "hdf5". + 4. HDF5 uses zlib for compression and zlib is NOT distributed + with hdf5 lib in 1.6.??? release. You have to install your own + zlib library or you may go to HDF web site + (ftp://ftp.ncsa.uiuc.edu/HDF/gzip/) + to download the correponding zlib library by yourself. If you + want to build HDF5 library without using zlib, please read section V. - 4. HDF5 uses zlib for compression and zlib is distributed - with hdf5 lib. If you have your own version read section - VI about the zlib library. + 5. HDF4-related tools are not built and released with HDF5 library + packages any more. To obtain HDF4-related tools, please check + http://hdf.ncsa.uiuc.edu/h4toh5/ and ftp://hdf.ncsa.uiuc.edu/HDF5/h4toh5/ + + 6. For .NET users, please go to section VI. + + 7. For DLL users, please do read and follow "DLL hints" at Section IV. + + 8. For users who would like to build, test and use HDF5 snapshot release, please + read Section VII. --------------------------------------------------------------- @@ -42,7 +49,10 @@ The following sections discuss installation procedures in detail: Section III: Building an application using the HDF5 library or DLL Section IV: Some more helpful pointers - Section V: ZLIB library - removing or changing the path + Section V: Disable gzip compression + Section VI: How to build in HDF5 in VS 7.0(.NET) + Section VII: Build and test HDF5 snapshot release + *************************************************************** @@ -65,9 +75,6 @@ What do we build and install? HDF5 tools: non-hdf4 related tools - for hdf4 related tools, please check http://hdf.ncsa.uiuc.edu/h4toh5/ - and ftp://hdf.ncsa.uiuc.edu/HDF5/h4toh5/ - HDF5 library testing programs: hdf5 library related comprehensive tests @@ -78,6 +85,10 @@ What do we build and install? HDF5 examples: simple HDF5 examples +NOTE: ** We use zlib 1.1.4 for both binary and source + release. + ** + ************************************************************** Section II: @@ -102,7 +113,26 @@ STEP 1: Building hdf5 libraries and non-hdf4 related tools Then open the c:\myHDFstuff\hdf5\proj\all\all.dsw workspace. - 3. Select "Build", then Select "Set Active Configuration". + 3. Select project hdf5dll, right click mouse; choose settings, + find "Link", go to the Category box and choose "Input", + go to the box "Object/library modules" and go to the end of the line; + see whether the zlib dll library path is the same as C:\zlib114\dll + or the correct path where you install your dll export library. + If not, replace the old zlib dll library path with the correct path. + + You should do this for both Debug and release version. + + 4. Go to "Tools" and select "Options", find "Directories"; + 4.1 Find the box "Show directories for", choose "Include files", + If you cannot find your zlib header path(for example, C:\zlib114\include) + from the directory list, + add the header path(C:\zlib114\include) to the included directories. + 4.2 Find the box "Show directories for", choose "Library files", + If you cannot find your zlib library path(for example, C:\zlib114\lib) + from the directory list, + add the library path(C:\zlib114\lib) to the included directories. + + 5. Select "Build", then Select "Set Active Configuration". On Windows platform select as the active configuration @@ -287,11 +317,13 @@ please choose font less than 14 for better alignment of the text. hdf5timingtest debug dll >"Your output filename" - Use notepad or notetab light to check results. You should + Use notepad or wordpad to check results. You should not find any FAILED marks in your output files. - Note: big test is currently not working for windows, we are -still investigating this. + Note: big test is currently not working for windows because it needs +to allocate more space, however, HDF5 can support more than 4GB +file if you are using NTFS. We still investigate the possibility to support +this test. 2. hdf5 tools testing @@ -458,7 +490,7 @@ To use the DLL: debug version. 3. Place the DLL in a location that Windows will be able to locate - it. The search path and order for DLL's is + it. The searched path and order for DLL's is a) The directory where the executable module for the current process is located. @@ -468,6 +500,8 @@ To use the DLL: d) The Windows directory. The GetWindowsDirectory function retrieves the path of this directory. e) The directories listed in the PATH environment variable. + 4. To modify your own application settings, please DO FOLLOW th "DLL Hints" + at section IV "MORE HELPFUL POINTERS". Section IV: @@ -534,41 +568,60 @@ DLL... hints: Section V: -ZLIB LIBRARY- REMOVING OR CHANGING THE PATH + +Disable gzip compression ============================================ -If you would like to remove the zlib library from the hdf5 library or -use your own version of the zlib library then follow the steps below. +If you would like to remove gzip compression from the hdf5 library +follow the steps below. -Removing the zlib library completely: - Open the all.dsw workspace file in Microsoft Visual C++. Go to the - hdf5 project. Select the zlib.lib file from this project and - delete(press the 'delete' key) it. Next open the H5config.h and H5pubconf.h - files from the src directory. Remove the the following two lines: + 1) Open the H5pubconf.h file from the src directory and remove the + following four lines: + #define H5_HAVE_ZLIB_H 1 #define H5_HAVE_LIBZ 1 - #define H5_HAVE_COMPRESS2 + #define H5_HAVE_COMPRESS2 1 + #define H5_HAVE_COMPRESSION 1 then save the file. - Next go to the hdf5dll project. Remove the zlib.lib from this - project too. Open the project settings for the hdf5dll project. - Go to the C/C++ settings tab and under the preprocessor definitions - remove the ZLIB_DLL in both the debug and the release settings. - Recompile the all project and then save the workspace. - - -Replacing the zlib library: - - Open the all.dsw workspace and go to the hdf5 project. Delete the - zlib.lib file from the file listing. Then select the hdf5 project - and richt click to get a menu. Pick the "add files to project..." - option and find the version of the zlib that you would like to use. - Then click OK in the file chooser dialog. Repeat the steps for the - hdf5dll project. You may also want to replace the zlib.h and zconf.h - files which are in the src directory with your own versions of these - files. Then recompile the all project. + 2) run-compile HDF5 library according to the previous steps. + +Section VI: + +How to build HDF5 in VS 7.0(.NET) +============================================ +We just briefly introduce you how to build HDF5 in VS 7.0(.NET); + +1. Open the old dataspace file with the "Open solution" option, +.NET will automatically convert the data space file to solution file. +2. Then find "Build" and go to "Configuration Manager"; choose "release" +or "debug", then choose "build all". +3. If you want to change some project setting, select the project and right +click the button to choose Properties; find the similar menu there as in 6.0. +4. You need to specify the zlib include header files and libraries under +Tools->Options->Projects->VC++ Directories and choose Include and libraries under +the category of "show directories for" to add the corresponding path. + +Note: Currently we only build and test .NET on windows XP. +Section VII: + +Build and test HDF5 snapshot release + +Note: This section is only for users who would like to build and test HDF5 snapshot release. + +If you want to test and build HDF5 snapshot release, you need extra steps to automatically +generate H5Tinit.c before going to section II step 1(2). + +Previous step: section II, step 1(1). +Extra steps: +1) After extracting all.zip to the correct path, open the + c:\myHDFstuff\hdf5\misc\typegen\typegen.dsw. +2) Build the project file. +3) Invoke command prompt and go to c:\myHDFstuff\hdf5\src. +4) type H5Tinit.exe >H5Tinit.c +5) Go back to section II, continue with step 1(2). Please send email to hdfhelp@ncsa.uiuc.edu for further assistance. -- cgit v0.12