mirror of
https://github.com/HDFGroup/hdf5.git
synced 2024-11-27 02:10:55 +08:00
Changes to docs for using plugins (#814)
* Changes to docs for using plugins * VS2019 corrections * Fix typo
This commit is contained in:
Allen Byrne
GitHub
parent
21c6bb38e6
commit
9ec773bb18
11
bin/release
11
bin/release
@ -229,11 +229,14 @@ tar2cmakezip()
|
||||
(cd $cmziptmpsubdir; echo "ctest -S HDF5config.cmake,BUILD_GENERATOR=VS201564 -C Release -V -O hdf5.log" > build-VS2015-64.bat; chmod 755 build-VS2015-64.bat)
|
||||
(cd $cmziptmpsubdir; echo "ctest -S HDF5config.cmake,BUILD_GENERATOR=VS2017 -C Release -V -O hdf5.log" > build-VS2017-32.bat; chmod 755 build-VS2017-32.bat)
|
||||
(cd $cmziptmpsubdir; echo "ctest -S HDF5config.cmake,BUILD_GENERATOR=VS201764 -C Release -V -O hdf5.log" > build-VS2017-64.bat; chmod 755 build-VS2017-64.bat)
|
||||
(cd $cmziptmpsubdir; echo "ctest -S HDF5config.cmake,BUILD_GENERATOR=VS2019 -C Release -V -O hdf5.log" > build-VS2019-32.bat; chmod 755 build-VS2019-32.bat)
|
||||
(cd $cmziptmpsubdir; echo "ctest -S HDF5config.cmake,BUILD_GENERATOR=VS201964 -C Release -V -O hdf5.log" > build-VS2019-64.bat; chmod 755 build-VS2019-64.bat)
|
||||
|
||||
# step 3: add LIBAEC.tar.gz, ZLib.tar.gz and cmake files
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/LIBAEC.tar.gz $cmziptmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/ZLib.tar.gz $cmziptmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/HDF5Examples-1.14.1-Source.zip $cmziptmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/HDF5Examples-1.14.2-Source.zip $cmziptmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/hdf5_plugins-master.zip $cmziptmpsubdir
|
||||
cp $cmziptmpsubdir/$version/config/cmake/scripts/CTestScript.cmake $cmziptmpsubdir
|
||||
cp $cmziptmpsubdir/$version/config/cmake/scripts/HDF5config.cmake $cmziptmpsubdir
|
||||
cp $cmziptmpsubdir/$version/config/cmake/scripts/HDF5options.cmake $cmziptmpsubdir
|
||||
@ -328,7 +331,8 @@ tar2cmaketgz()
|
||||
# step 3: add LIBAEC.tar.gz, ZLib.tar.gz and cmake files
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/LIBAEC.tar.gz $cmgztmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/ZLib.tar.gz $cmgztmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/HDF5Examples-1.14.1-Source.tar.gz $cmgztmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/HDF5Examples-1.14.2-Source.tar.gz $cmgztmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/hdf5_plugins-master.tar.gz $cmgztmpsubdir
|
||||
cp $cmgztmpsubdir/$version/config/cmake/scripts/CTestScript.cmake $cmgztmpsubdir
|
||||
cp $cmgztmpsubdir/$version/config/cmake/scripts/HDF5config.cmake $cmgztmpsubdir
|
||||
cp $cmgztmpsubdir/$version/config/cmake/scripts/HDF5options.cmake $cmgztmpsubdir
|
||||
@ -411,7 +415,8 @@ tar2hpccmaketgz()
|
||||
# step 3: add LIBAEC.tar.gz, ZLib.tar.gz and cmake files
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/LIBAEC.tar.gz $cmgztmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/ZLib.tar.gz $cmgztmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/HDF5Examples-1.14.1-Source.tar.gz $cmgztmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/HDF5Examples-1.14.2-Source.tar.gz $cmgztmpsubdir
|
||||
cp /mnt/scr1/pre-release/hdf5/CMake/hdf5_plugins-master.tar.gz $cmgztmpsubdir
|
||||
cp $cmgztmpsubdir/$version/config/cmake/scripts/CTestScript.cmake $cmgztmpsubdir
|
||||
cp $cmgztmpsubdir/$version/config/cmake/scripts/HDF5config.cmake $cmgztmpsubdir
|
||||
|
||||
|
||||
@ -77,7 +77,7 @@ set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DSITE:STRING=${CTEST_SITE} -DBUILDN
|
||||
|
||||
#TAR_SOURCE - name of tarfile
|
||||
#if(NOT DEFINED TAR_SOURCE)
|
||||
# set(CTEST_USE_TAR_SOURCE "HDF5Examples-1.14.1-Source")
|
||||
# set(CTEST_USE_TAR_SOURCE "HDF5Examples-1.14.2-Source")
|
||||
#endif()
|
||||
|
||||
###############################################################################################################
|
||||
|
||||
@ -42,8 +42,11 @@
|
||||
### enable JAVA builds
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF_BUILD_JAVA:BOOL=ON")
|
||||
|
||||
#############################################################################################
|
||||
### enable FILTERS builds
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF_BUILD_FILTERS:BOOL=ON")
|
||||
### default HDF5_PLUGIN_PATH to where the filter libraries are located
|
||||
#set(ENV{HDF5_PLUGIN_PATH} "${INSTALLDIR}/lib/plugin")
|
||||
|
||||
#############################################################################################
|
||||
### enable parallel program builds
|
||||
|
||||
@ -11,7 +11,7 @@
|
||||
#
|
||||
#############################################################################################
|
||||
### ${CTEST_SCRIPT_ARG} is of the form OPTION=VALUE ###
|
||||
### BUILD_GENERATOR required [Unix, VS2017, VS201764, VS2015, VS201564, VS2013, VS201364] ###
|
||||
### BUILD_GENERATOR required [Unix, VS2019, VS201964, VS2017, VS201764, VS2015, VS201564] ###
|
||||
### ctest -S HDF5config.cmake,BUILD_GENERATOR=VS201764 -C Release -VV -O hdf5.log ###
|
||||
#############################################################################################
|
||||
|
||||
@ -68,7 +68,7 @@ endif ()
|
||||
|
||||
# build generator must be defined
|
||||
if (NOT DEFINED BUILD_GENERATOR)
|
||||
message (FATAL_ERROR "BUILD_GENERATOR must be defined - Unix, VS2017, or VS201764, VS2015, VS201564, VS2013, VS201364")
|
||||
message (FATAL_ERROR "BUILD_GENERATOR must be defined - Unix, VS2019, VS201964, VS2017, or VS201764, VS2015, VS201564")
|
||||
endif ()
|
||||
|
||||
###################################################################
|
||||
@ -163,7 +163,7 @@ if (NOT DEFINED HPC)
|
||||
set (SITE_COMPILER_NAME "vs2012")
|
||||
set (SITE_COMPILER_VERSION "11")
|
||||
else ()
|
||||
message (FATAL_ERROR "Invalid BUILD_GENERATOR must be - Unix, VS2017, or VS201764, VS2015, VS201564, VS2013, VS201364")
|
||||
message (FATAL_ERROR "Invalid BUILD_GENERATOR must be - Unix, VS2019, VS201964, VS2017, or VS201764, VS2015, VS201564")
|
||||
endif ()
|
||||
## Set the following to unique id your computer ##
|
||||
set (CTEST_SITE "WIN7${BUILD_GENERATOR}.XXXX")
|
||||
|
||||
@ -69,7 +69,7 @@ set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ALLOW_EXTERNAL_SUPPORT:STRIN
|
||||
#set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SZIP_ENCODING:BOOL=OFF")
|
||||
|
||||
#### package examples ####
|
||||
#set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_PACK_EXAMPLES:BOOL=ON -DHDF5_EXAMPLES_COMPRESSED:STRING=HDF5Examples-1.14.1-Source.tar.gz -DHDF5_EXAMPLES_COMPRESSED_DIR:PATH=${CTEST_SCRIPT_DIRECTORY}")
|
||||
#set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_PACK_EXAMPLES:BOOL=ON -DHDF5_EXAMPLES_COMPRESSED:STRING=HDF5Examples-1.14.2-Source.tar.gz -DHDF5_EXAMPLES_COMPRESSED_DIR:PATH=${CTEST_SCRIPT_DIRECTORY}")
|
||||
|
||||
#############################################################################################
|
||||
### enable parallel builds
|
||||
|
||||
@ -1,15 +1,16 @@
|
||||
This tar file contains
|
||||
|
||||
build-unix.sh script to build HDF5 with CMake on unix machines
|
||||
build-unix-hpc.sh script to build HDF5 with CMake on unix machines and run
|
||||
tests with batch scripts (sbatch).
|
||||
build-unix.sh script to build HDF5 with CMake on unix machines
|
||||
build-unix-hpc.sh script to build HDF5 with CMake on unix machines and run
|
||||
tests with batch scripts (sbatch).
|
||||
CTestScript.cmake
|
||||
HDF5config.cmake CMake scripts for building HDF5
|
||||
HDF5config.cmake CMake scripts for building HDF5
|
||||
HDF5options.cmake
|
||||
hdf5-1.13.0 HDF5 1.13.0 source
|
||||
LIBAEC.tar.gz source for building SZIP replacement
|
||||
ZLib.tar.gz source for building ZLIB
|
||||
hdf5_plugins.tar.gz source for building compression plugins
|
||||
hdf5-1.13.0 HDF5 1.13.0 source
|
||||
LIBAEC.tar.gz source for building SZIP replacement
|
||||
ZLib.tar.gz source for building ZLIB
|
||||
hdf5_plugins.tar.gz source for building compression plugins
|
||||
HDF5Examples-1.14.2-Source.tar.gz source for building examples
|
||||
|
||||
For more information about building HDF5 with CMake, see USING_HDF5_CMake.txt in
|
||||
hdf5-1.13.0/release_docs, or
|
||||
|
||||
@ -83,6 +83,7 @@ III. Defaults in the HDF5_Examples_options.cmake file
|
||||
#### HDF_BUILD_CXX:BOOL=OFF ###
|
||||
#### HDF_BUILD_FORTRAN:BOOL=OFF ###
|
||||
#### HDF_BUILD_JAVA:BOOL=OFF ###
|
||||
#### HDF_BUILD_FILTERS:BOOL=OFF ###
|
||||
#### BUILD_TESTING:BOOL=OFF ###
|
||||
#### HDF_ENABLE_PARALLEL:BOOL=OFF ###
|
||||
#### HDF_ENABLE_THREADSAFE:BOOL=OFF ###
|
||||
|
||||
@ -41,13 +41,30 @@ I. Preconditions
|
||||
|
||||
2. You have installed the HDF5 library built with CMake, by executing
|
||||
the HDF Install Utility (the *.msi file in the binary package for
|
||||
Windows). If you are using a Windows platform, you can obtain a
|
||||
pre-built Windows binary from The HDF Group's website at
|
||||
Windows). You can obtain pre-built binaries from The HDF Group's website at
|
||||
www.hdfgroup.org.
|
||||
|
||||
3. Set the environment variable HDF5_DIR to the installed location of
|
||||
the config files for HDF5. On Windows:
|
||||
the config files for HDF5.
|
||||
On Windows:
|
||||
HDF5_DIR=C:/Program Files/HDF_Group/HDF5/1.13.x/cmake
|
||||
On unix:
|
||||
HDF5_DIR=<install root folder>/HDF_Group/HDF5/1.13.x/cmake
|
||||
|
||||
If you are using shared libraries, you may need to add to the path
|
||||
environment variable. Set the path environment variable to the
|
||||
installed location of the library files for HDF5.
|
||||
On Windows (*.dll):
|
||||
PATH=%PATH%;C:/Program Files/HDF_Group/HDF5/1.13.x/bin
|
||||
On unix (*.so):
|
||||
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<install root folder>/HDF_Group/HDF5/1.13.x/lib
|
||||
|
||||
If you are using filter plugin libraries, you will need to set the
|
||||
HDF5_PLUGIN_PATH environment variable.
|
||||
On Windows:
|
||||
HDF5_PLUGIN_PATH=C:/Program Files/HDF_Group/HDF5/1.13.x/lib/plugin
|
||||
On unix:
|
||||
HDF5_PLUGIN_PATH=<install root folder>/HDF_Group/HDF5/1.13.x/lib/plugin
|
||||
|
||||
(Note there are no quote characters used on Windows and all platforms
|
||||
use forward slashes)
|
||||
@ -99,12 +116,13 @@ These steps are described in more detail below.
|
||||
* MinGW Makefiles
|
||||
* NMake Makefiles
|
||||
* Unix Makefiles
|
||||
* Visual Studio 12 2013
|
||||
* Visual Studio 12 2013 Win64
|
||||
* Visual Studio 14 2015
|
||||
* Visual Studio 14 2015 Win64
|
||||
* Visual Studio 15 2017
|
||||
* Visual Studio 15 2017 Win64
|
||||
* Visual Studio 16 2019
|
||||
* ... in addition VS2019 will need to set the "-A" option,
|
||||
* ... [Win32, x64, ARM, ARM64]
|
||||
|
||||
<options> is:
|
||||
* BUILD_TESTING:BOOL=ON
|
||||
@ -114,7 +132,7 @@ These steps are described in more detail below.
|
||||
|
||||
2.1 Visual CMake users, click the Configure button. If this is the first time you are
|
||||
running cmake-gui in this directory, you will be prompted for the
|
||||
generator you wish to use (for example on Windows, Visual Studio 12 2013).
|
||||
generator you wish to use (for example on Windows, Visual Studio 14 2015 Win64).
|
||||
CMake will read in the CMakeLists.txt files from the source directory and
|
||||
display options for the HDF5 project. After the first configure you
|
||||
can adjust the cache settings and/or specify locations of other programs.
|
||||
@ -132,7 +150,7 @@ These steps are described in more detail below.
|
||||
|
||||
2.2 Alternative command line example on Windows in c:\MyHDFstuff\hdf5\build directory:
|
||||
|
||||
cmake -G "Visual Studio 12 2013" -DBUILD_TESTING:BOOL=ON ..
|
||||
cmake -G "Visual Studio 14 2015 Win64" -DBUILD_TESTING:BOOL=ON ..
|
||||
|
||||
3. Build HDF5 Applications
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user