From 3fd6b91f1ba2d718b6578066005503b234d5fce4 Mon Sep 17 00:00:00 2001 From: Scott Wegner Date: Tue, 24 Apr 2007 15:07:12 -0500 Subject: [svn-r13701] Deleted .html versions of Windows documentation, as we have decided to maintain only .txt versions in the source package. Step-by-step instructions for Windows will eventually be made available on the public website. Updated MANIFEST to reflect changes. --- MANIFEST | 5 - release_docs/INSTALL_Windows.html | 5466 -------------------- .../INSTALL_Windows_From_Command_Line.html | 1038 ---- release_docs/INSTALL_Windows_Short_Intel.htm | 639 --- release_docs/INSTALL_Windows_Short_MSVS6.0.htm | 420 -- release_docs/INSTALL_Windows_Short_Net.htm | 787 --- 6 files changed, 8355 deletions(-) delete mode 100755 release_docs/INSTALL_Windows.html delete mode 100755 release_docs/INSTALL_Windows_From_Command_Line.html delete mode 100755 release_docs/INSTALL_Windows_Short_Intel.htm delete mode 100755 release_docs/INSTALL_Windows_Short_MSVS6.0.htm delete mode 100755 release_docs/INSTALL_Windows_Short_Net.htm diff --git a/MANIFEST b/MANIFEST index 8005f8c..5a01ff9 100644 --- a/MANIFEST +++ b/MANIFEST @@ -388,15 +388,10 @@ ./release_docs/INSTALL ./release_docs/INSTALL_Cygwin.txt ./release_docs/INSTALL_VMS.txt -./release_docs/INSTALL_Windows.html ./release_docs/INSTALL_Windows.txt -./release_docs/INSTALL_Windows_From_Command_Line.html ./release_docs/INSTALL_Windows_From_Command_Line.txt -./release_docs/INSTALL_Windows_Short_Intel.htm ./release_docs/INSTALL_Windows_Short_INTEL.TXT -./release_docs/INSTALL_Windows_Short_MSVS6.0.htm ./release_docs/INSTALL_Windows_Short_MSVS6.0.TXT -./release_docs/INSTALL_Windows_Short_Net.htm ./release_docs/INSTALL_Windows_Short_NET.TXT ./release_docs/INSTALL_codewarrior.txt ./release_docs/INSTALL_parallel diff --git a/release_docs/INSTALL_Windows.html b/release_docs/INSTALL_Windows.html deleted file mode 100755 index fea6cdb..0000000 --- a/release_docs/INSTALL_Windows.html +++ /dev/null @@ -1,5466 +0,0 @@ - - - - - - - - - - - HDF5 Build and Install Instructions for Windows XP (Full -Version) - - - - - - - - -

HDF5 Build and Install Instructions for Windows XP (Full -Version)

- -
-

Notes:

- -

The following instructions assume that the -HDF5 source code package from HDF website (http://hdfgroup.org) -is used.

- -

Table of Contents:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Preconditions

- -
-

Section -I   

- - 		-

  What do we -build and install

- -
-

Section -II  

- - 		-

  How to -build and test HDF5 libraries and tools

- -
-

Section -III 

- - 		-

  -How to Build Examples (Optional)

- -
-

Section IV 

- - 		-

  How to -build an application using the HDF5 library or DLL

- -
-

Section -V  

- - 		-

  How to -disable Gzip(Zlib)/Szip compression

- -
-

Section VI 

- - 		-

  How to -build HDF5 in .NET 2003

- -
-

Section VII

- - 		-

  How to -build HDF5 with INTEL Compiler

- -
-

Section VIII

- - 		-

  How to -build Multi-threaded version of HDF5 library

- -
-

Section IX 

- - 		-

  How to -build and test HDF5 snapshot release

- -
-

Section -X  

- - 		-

 How to -build -HDF5 with Thread-Safe Feature

- -
-

Section -XI  

- - 		-

  How to -build HDF5 in Visual Studio 2005

- -
-

Section -XII  

- - 		-

  Misc.

- -
- -
-

Preconditions

- -
-

Please read CAREFULLY about the following preconditions and -notes first.

- -

1. Installed Microsoft Visual C++ 6.0 or Intel C -compiler and WinZip.

- -
-

Installed Compaq Visual Fortran compiler(6.0 or higher -version), or Intel Fortran compiler if you want to build HDF5 Fortran -libraries.

- -

Notes:

- -

By default, WinZip will convert the Unix -end of line format when extracting .tar file. This conversion will -cause "false" failure in some HDF5 tools testings. Please uncheck the -"TAR file smart CR/LF conversion" option in your WinZip to prevent the -conversion when extracting .tar file. To uncheck the "TAR file smart -CR/LF conversion" option: Invoke WinZip, go to "Options", select -"Configuration..." Click the "Miscellaneous" tab and uncheck "TAR file -smart CR/LF conversion" option, then click OK.

- -
- -

2. Set up a directory structure to unpack the -library.

- -

For example:

- - - - - - - - - - - - - - - - - - -
-

c:\ -(any drive)

- -
-

MyHDFstuff\ -(any folder name)

- -
- -

 

- -

3. Download the hdf5-1.8.x source code package -

- -

Use WinZip to extract the HDF5 package into c:\MyHDFstuff. This creates a -directory called 'hdf5-1.8.x' under MyHDFstuff -which contains several files and directories. Rename "hdf5-1.8.x" to "hdf5".

- -

4. HDF5 provide options to do in-memory compress -within HDF5 library.

- -

Currently, two external compression libraries Zlib and Szip -can be used with HDF5.

- - - -

5. Define the following environment variables: -

- - - -

In this section, Zlib and Szip compression packages are -assumed to be used. Please read Section -V as well as this section if you do not want to use -compression feature inside HDF5.

- -

To define these environment variables:

- -

Click "Start" --> "Control Panel" --> "System" --> "Advanced"  --> "Environment Variables". -If you are logged on as administrator to the local computer AND want to -let all other users use these two environment variables, click -"New" under "System Variables" box; -otherwise, click "New" -under -"User Variables" box. -In the New Variable window, set

- -

"Variable name" -as HDF5_EXT_ZLIB

- -

"Variable value" -as zdll.lib, then -click OK.

- -

Similarly, you can set:

- -

HDF5_EXT_SZIP -environment variable as -szlibdll.lib

- -

Notes:

- - - -

6. Set up path -for external libraries and headers

- -

Skip this part if you don't want to use ANY compression -features provided by HDF5. Please do read Section -V.

- -

You have to read this part even if you want to only use Zlib -or Szip. You also need to read Section -V.

- -

Invoke Microsoft Visual C++ and go to "Tools" and select -"Options", find "Directories"; -

- - - -

Notes:

- - - -

Go -to TOP Preconditions

- -

Go -to Table of Contents

- -
-

Section I: What do we build -and install?

- -
- - -

Go -to Table of Contents

- -
-

Section II: How to build and -test HDF5 libraries and tools -

- -
-

This section includes:

- -

STEP 1: Building HDF5 -libraries and tools

- -

STEP 2: Testing HDF5 -libraries and tools

- -

STEP 3: Installing HDF5 -Libraries

- -

 

- -

STEP 1: -Building HDF5 libraries and tools

- - - -

STEP 2: -Testing HDF5 libraries and tools

- -

HDF5 libraries and tools should be tested to make sure that -they were built correctly.

- -

We provide 2 options for users to test HDF5 libraries and -tools.

- -

Option 1: Automatic Testings

- -

HDF5 comes with various test suites, all of which can be -tested with hdf5check.bat batch file in c:\MyHDFstuff\hdf5 directory.

- -

hdf5check batch file can be run with one of the following four -options:

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionsIllustration
-

hdf5check

- - 		-

test HDF5 C library and tools only

- -
-

hdf5check enablecpp

- - 		-

test HDF5 C/C++ libraries and tools.

- -

To use this option, HDF5 C++ libraries must have been -built in step I.

- -
-

hdf5check enablefortran

- - 		-

test HDF5 C/FORTRAN libraries and tools

- -

To use this option, HDF5 Fortran libraries must have -been built in step I.

- -
-

hdf5check enableall

- - 		-

test HDF5 C/C++/FORTRAN libraries and tools

- -

To use this option, HDF5 C++ and Fortran libraries must -have been built in step I.

- -
- -
- -

Invoke a command prompt window and run hdf5check with -appropriate option.

- -

Test results are saved in two files:

- -

c:\MyHDFstuff\hdf5\check_results.txt

- -

c:\MyHDFstuff\hdf5\tests_results.txt.

- -

In general, you only need to check -tests_results.txt. If all the tests passed, then you do -not have to check check_results.txt. -If some tests failed, check check_results.txt -can help you figure out what was wrong.

- -

Option 2: Step-by-step HDF5 libraries and tools testings

- -

You can also test HDF5 libraries and tools one by one. There -are four versions of HDF5 libraries and tools testing. They are:

- - - -

We strongly suggest you to redirect your testing results into -an output file so that you can easily check the testing results. You -may use either Notepad or WordPad or whatever other windows word -processor to check the results. For the purpose of printing, please -choose font less than 14 for better alignment of the text. -

- -

DLLs listed below should be placed into the Windows system -directory. A batch file named install_dll.bat -is included in -c:\MyHDFstuff\hdf5 -directory. Run this batch file and the following HDF5 DLLs will be -copied to the system directory.

- - - - - -

STEP 3: -Installing HDF5 Libraries

- -

We provide a batch file for users to relocate all HDF5 -libraries in one folder (C++ and Fortran libraries will also be copied -into this folder if they have been built in step I). The file is called -installhdf5lib.bat -under c:\MyHDFstuff\hdf5 -directory. Run the batch file, you may see a folder called hdf5lib -under c:\MyHDFstuff\hdf5. -

- -

The <release> layout of <hdf5lib> -should be:

- - - -

You may also find the similar layout for the -<debug>.

- -

Go to -TOP Section II

- -

Go -to Table of Contents

- -
-

Section III: How to -build Examples (Optional)

- -
-

This section include:

- -

How to build and test C -examples

- -

How to build and test C++ -examples

- -

How to build and test -Fortran examples

- -

How to build and test High -Level C examples

- -

How to build and test -High Level Fortran examples

- -

Notes:

- - - -

 

- -
- - -

3. Backward compatibility with 1.6

- - - -

Go to -TOP Section XII

- -

Go -to Table of Contents

- -
-

Need further assistance? email to help@hdfgroup.org -or go to http://hdfgroup.org/windows/questions -to get help on Windows

- -

Thank  -you  for  using  Hierarchical  -Data  Format  (HDF)

- -

 

- -

 

- -

- -

- -

- - - diff --git a/release_docs/INSTALL_Windows_From_Command_Line.html b/release_docs/INSTALL_Windows_From_Command_Line.html deleted file mode 100755 index e0a88a8..0000000 --- a/release_docs/INSTALL_Windows_From_Command_Line.html +++ /dev/null @@ -1,1038 +0,0 @@ - - - - - - - Instructions for Building and Testing HDF5 from Command -Line on Windows XP - - - - - - - - - - -

Instructions for Building and Testing HDF5 on Windows XP

- -

from Command Line

- -
-

Notes:

- -

1. This instruction is written for users who would like to -build HDF5 libraries and tools from the HDF5 source code package on -command line. -

- -

2. Currently, we support:

- - - -

3. Please read CAREFULLY about HDF5 build -and install preconditions and notes in INSTALL_Windows.txt -before starting below procedures.

- -
-

Section I: Building and testing HDF5 with Microsoft Visual -C++ 6.0 and Compaq Visual Fortran 6.0.

- -
-

1. Preconditions:

- - - -

2. Building and testing HDF5 libraries and tools

- -

We provide 2 options for users to build test HDF5 libraries -and tools.

- - - - - diff --git a/release_docs/INSTALL_Windows_Short_Intel.htm b/release_docs/INSTALL_Windows_Short_Intel.htm deleted file mode 100755 index 72f25fe..0000000 --- a/release_docs/INSTALL_Windows_Short_Intel.htm +++ /dev/null @@ -1,639 +0,0 @@ - - - - - - - HDF5 Build and Install Instructions for Windows XP with -INTEL Compiler - - - - - - - - - - -

HDF5 Build and Install Instructions for Windows XP with INTEL -Compiler

- -

(Short Version)

- -
-

Notes:

- -

1. This short instruction is written for users who want to -quickly build HDF5 library and tools from the HDF5 source code package -with Intel Compiler but do not want to know HDF5 building and -installation details on Windows XP. For detailed HDF5 build and install -information, or if you have trouble following any steps in the -instructions, please refer to INSTALL_Windows.txt for further -information. For users who would like to build and test HDF5 package -from the command line, please refer to -INSATLL_Windows_From_Command_Line.txt.

- -

2. For Intel Compiler users, Intel 7.x works with MSVS 6.0 and -Intel 8.1 only works with MSVS .net 2003 when you build HDF5-1.8.x.

- -

3. HDF5 Fortran DLL Libraries is not supported with Intel -Fortran 8.1 integration with Visual C++ .Net 2003 Environment. But -Release version of HDF5 Fortran DLL Libraries works with Intel Fortran -whilt Debug version doesn't.

- -

4. Szip library is different when using Intel compiler. You -should build Szip source codes with Intel compiler or download binaries -for Intel compiler from -ftp://ftp.ncsa.uiuc.edu/HDF/szip/2.0/bin/windows.

- -

5. Set up path for external libraries and headers

- - - -

- -

6. Part -II, 2.1 in this document will build ONLY HDF5 Static and DLL -C and C++ Library using Intel C++ Compiler. If you want to build HDF5 -Static and DLL C and C++ Library as well as HDF5 Static Fortran -Library, Please go to Part -II, 2.2 directly!

- -

7. Only short information was given on test HDF5 Libraries. -Users want to know detailed information about testing HDF5 Libraries -and tools, please refer to document INSTALL_Windows.html, Section II, STEP 2 -Testing HDF5 libraries and tools.

- -

8. If  you are not building HDF5 with Thread-Safe -Feature, ttsafedll.dsp should always be turned off.

- -

Warnings:

- -

Please read CAREFULLY about -HDF5 build and install preconditions and notes in -INSTALL_Windows.txt before starting below procedures.

- -
-

Part I. Building HDF5 with INTEL compiler 7.1 with MSVS 6.0

- -
- - -
-

Part II. Building HDF5 with INTEL compiler 8.1 with Visual -C++ .Net 2003 Environment

- -
- - -
-

Part III Build HDF5 C and C++ Library with Intel C++ Compiler

- -
- - -
-

Part IV: Installing HDF5 Libraries

- -
-

Run the batch file c:\MyHDFstuff\hdf5\installhdf5lib.bat to -install all HDF5 libraries and tools into c:\MyHDFstuff\hdf5\hdf5lib -directory.

- -
-

Part V: Building HDF5 Examples (Optional)

- -
-

Please read section II, step 4 in INSTALL_Windows.html.

- -
-

Need further assistance? email to help@hdfgroup.org -or go to http://hdfgroup.org/windows/questions/questions.html -to get help on windows

- -

Thank  -you  for  using  Hierarchical  -Data  Format  (HDF)

- -

 

- -

 

- -

 

- -

 

- - - diff --git a/release_docs/INSTALL_Windows_Short_MSVS6.0.htm b/release_docs/INSTALL_Windows_Short_MSVS6.0.htm deleted file mode 100755 index d9a38d8..0000000 --- a/release_docs/INSTALL_Windows_Short_MSVS6.0.htm +++ /dev/null @@ -1,420 +0,0 @@ - - - - - - - HDF5 Build and Install Instructions for Windows XP with -MSVS 6.0 - - - - - - - - - - -

HDF5 Build and Install Instructions for Windows XP with MSVS -6.0

- -

(Short Version)

- -
-

Notes:

- -

This short instruction is written for users who want to -quickly -build HDF5 library and tools from the HDF5 source code package -with Microsoft Visual Studio 6.0 but do not want to know HDF5 building -and installation details on Windows XP. -

- -

For detailed HDF5 build and install information, or if you -have -trouble following any steps in the instructions, please refer to -INSTALL_Windows.html for further information. -

- -

For users who would like to build and test HDF5 package from -the -command line, please refer to -INSATLL_Windows_From_Command_Line.html. -

- -

Warnings: Please read CAREFULLY about HDF5 -build and install preconditions and notes in INSTALL_Windows.html -before starting below procedures.

- -
-

STEP 1: Building HDF5 Libraries and Tools

- -
- - -
-

STEP 2: Testing HDF5 Libraries and Tools

- -
-

HDF5 libraries and tools should be tested to make sure that -they were -built correctly.

- -

HDF5 libraries and tools can be tested with hdf5check.bat -batch file in c:\MyHDFstuff\hdf5 directory. -

- -

hdf5check.bat has four options:

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionsIllustration
-

hdf5check

- - 		-

test HDF5 C library and tools only

- -
-

hdf5check enablecpp

- - 		-

test HDF5 C/C++ libraries and tools.

- -
-

hdf5check enablefortran

- - 		-

test HDF5 C/FORTRAN libraries and tools

- -
-

hdf5check enableall

- - 		-

test HDF5 C/C++/FORTRAN libraries and tools

- -
- -
- -

Invoke a command prompt window and run hdf5check with -appropriate options.

- -

Test results are saved into file:

- - - -

Check check_results.txt and there should be no failures at all.

- -

If you want to test HDF5 libraries and tools one by one, -please refer to Section II, step 2 in INSTALL_Windows.html.

- -
-

STEP 3: Installing HDF5 Libraries

- -
-

Run the batch file c:\MyHDFstuff\hdf5\installhdf5lib.bat to -install all HDF5 libraries and tools into c:\MyHDFstuff\hdf5\hdf5lib -directory.

- -
-

STEP 4: Building HDF5 Examples (Optional)

- -
-

Please read section II, step 4 in INSTALL_Windows.html. -

- -
-

Need further assistance? email to help@hdfgroup.org -or go to http://hdfgroup.org/windows/questions.html -to get help on windows

- -

Thank  -you  for  using  Hierarchical  -Data  Format  (HDF)

- -

 

- -

 

- -

 

- - - diff --git a/release_docs/INSTALL_Windows_Short_Net.htm b/release_docs/INSTALL_Windows_Short_Net.htm deleted file mode 100755 index 690ce36..0000000 --- a/release_docs/INSTALL_Windows_Short_Net.htm +++ /dev/null @@ -1,787 +0,0 @@ - - - - - - - - - - - - - - HDF5 Build and Install Instructions for Windows XP with MSVS .NET 2003 - - - - - - - -

HDF5 Build and Install Instructions for Windows XP with MSVS -.NET 2003

- - -

(Short Version)

- - -
-

Notes:

- - -

1. This short instruction is written for users who want to -quickly build HDF5 library and tools from the HDF5 source code package -with Microsoft Visual Studio .NET 2003 but do not want to know HDF5 -building and installation details on Windows XP.

- - -

2. For detailed HDF5 build and install information, or if you -have trouble following any steps in the instructions, please refer to -INSTALL_Windows.html for further information.

- - -

3. For users who would like to build and test HDF5 package -from the command line, please refer to -INSATLL_Windows_From_Command_Line.txt.

- - -

4. For .Net and Intel users, If  you are not in -building HDF5 with Thread-Safe Feature, ttsafedll.dsp should always be turned -off.

- - -

Warnings: Please read CAREFULLY about -HDF5 build and install preconditions and notes before -starting below procedures.

- - -
-

Preconditions:

- - -
-

a. Setup path Visual Studio .Net 2003 Compiler.

- - -

Open "System" in Control Panel.

- - -

On the "Advanced" tab, click "Environment Variables", click -"Path" in the "System variables" box, then click "Edit" and add your -Visual C++ .Net path (For example, C:\Program Files\Microsoft Visual -Studio .NET 2003\Common7\IDE) into "Variable Value" and click "OK".

- - -

b. Set up path for external libraries and headers

- - -

Skip this part if you don't want to use ANY compression -features provided by HDF5. Read Section V in INSTALL_WINDOWS.html. -

- - -

You have to read this part even if you want to only use Zlib -or Szip. You also need to read Section V in INSTALL_WINDOWS.html -.

- - -

Invoke Microsoft Visual C++ .Net and go to "Tools" and select -"Options". In the left pane of "Option" window poped up, choose and -extend "Projects", Click on "VC++ Directories". In the right pane, Find -the box "Show directories for", choose "Include files", if you can not -find your Zlib and Szip header path (for example, c:\zlib122\include, -c:\szip\include) from the directory list, add the header path -(c:\zlib122\include, c:\szip\include) to the included directories.

- - -

Find the box "Show directories for", choose "Library files", -If you cannot find your Zlib and Szip library path (for example, -c:\zlib122\lib, c:\szip\dll) from the directory list, add the library -path (c:\zlib122\lib, c:\szip\dll) to the library directories.

- - -
-

STEP 1: Building HDF5 Libraries and Tools

- - -
-

1. Open all.dsw workspace

- - -

Notes:

- - -

Notes: all.sln is for command use only. Please open all.dsw -not all.sln.

- - -

Invoke Microsoft Visual C++ .Net 2003. From the main menu, go -to "File" and select "Open Solution". In the "Open Solution" window, -Change "Files of type" to "All Project Files". Choose "all.dsw" under -the directory c:\MyHDFstuff\hdf5\windows\proj\all. In the pop up -window, chooise "Yes To All" to convert all project files to Visual C++ -.Net project format.

- - -

2. Building HDF5 C and C++ Libraries

- - -

Users can choose the desirable libraries to be built according -to the following describtion.

- - - - - -
-

STEP 2: Testing HDF5 Libraries and Tools

- - -
-

HDF5 libraries and tools should be tested to make sure that -they were -built correctly.

- - -

HDF5 libraries and tools can be tested with hdf5check.bat -batch file in c:\MyHDFstuff\hdf5 directory.

- - -

hdf5check.bat has four options:

- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionsIllustration
- -

hdf5check

- - - 		- -

test HDF5 C library and tools only

- - -
- -

hdf5check enablecpp

- - - 		- -

test HDF5 C/C++ libraries and tools.

- - -
- -

hdf5check enablefortran

- - - 		- -

test HDF5 C/FORTRAN libraries and tools

- - -
- -

hdf5check enableall

- - - 		- -

test HDF5 C/C++/FORTRAN libraries and tools

- - -
- - -
- - -

Invoke a command prompt window and run hdf5check with -appropriate options.

- - -

Test results are saved into file:

- - - - - -

Check check_results.txt and there should be no failures at all.

- - -

If you want to test HDF5 libraries and tools one by one, -please refer to Section II, step 2 in INSTALL_Windows.html.

- - -
-

Check check_results.txt and there should be no failures at all.

- - -

If you want to test HDF5 libraries and tools one by one, -please refer to Section II, step 2 in INSTALL_Windows.html.

- - -
-

STEP 3: Installing HDF5 Libraries

- - -
-

Run the batch file c:\MyHDFstuff\hdf5\installhdf5lib.bat to -install all HDF5 libraries and tools into c:\MyHDFstuff\hdf5\hdf5lib -directory.

- - -
-

STEP 4: Building HDF5 Examples (Optional)

- - -
-

Please read section II, step 4 in INSTALL_Windows.html.

- - -
-

Need further assistance? email to help@hdfgroup.org -or go to http://hdfgroup.org/windows/questions.html -to get help on windows

- - -

Thank  -you  for  using  Hierarchical  -Data  Format  (HDF)

- - -

 

- - -

 

- - -

 

- - - - -- cgit v0.12