************************************************************************

* Build and Install HDF5 Applications with CMake *

************************************************************************

Notes: This short instruction is written for users who want to quickly
build HDF5 applications using the CMake tools. Users can adapt
these instructions for their own applications. For more information,
see the "Minimum C Project Files for CMake" section.

More information about using CMake can be found at the KitWare

site, www.cmake.org.

CMake uses the command line; however, the visual CMake tool is
available for the configuration step. The steps are similar for
all of the operating systems supported by CMake.

NOTES:
1. Using CMake for building and using HDF5 is under active
development. While we have attempted to provide error-free
files, please understand that development with CMake has not
been extensively tested outside of HDF. The CMake specific
files may change before the next release.

2. CMake for HDF5 development should be usable on any system

where CMake is supported. Please send us any comments on how
CMake support can be improved on any system.

3. See the appendix at the bottom of this file for an example

of using a ctest script for building and testing. See
INSTALL_CMake.txt for more information.

========================================================================
I. Preconditions
========================================================================

1. We suggest you obtain the latest CMake for windows from the Kitware
web site. The HDF5 1.10.x product requires a minimum CMake version
of 3.10.1.

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
www.hdfgroup.org.

3. Set the environment variable HDF5_DIR to the installed location of

the config files for HDF5. On Windows:
HDF5_DIR=C:/Program Files/HDF_Group/HDF5/1.10.x/cmake

(Note there are no quote characters used on Windows and all platforms
use forward slashes)

4. Created separate source and build directories.

(CMake commands are executed in the build directory)

5. Created a CMakeLists.txt file(s) for your source. See Section III

below.
========================================================================
II. Building HDF5 Applications with CMake
========================================================================

Go through these steps to build HDF5 applications with CMake.

(The application must support building with CMake.)

1. Run CMake
2. Configure the cache settings
3. Build HDF5 Applications
4. Test HDF5 Applications

These steps are described in more detail below.

1. Run CMake

The visual CMake executable is named "cmake-gui.exe" on Windows and should be

available in your Start menu. For Linux, UNIX, and Mac users the
executable is named "cmake-gui" and can be found where CMake was
installed.

Specify the source and build directories. Make the build and source
directories different. For example on Windows, if the source is at
c:\MyHDFstuff\hdf5, then use c:\MyHDFstuff\hdf5\build or
c:\MyHDFstuff\build\hdf5 for the build directory.

PREFERRED:
Users can perform the configuration step without using the visual
cmake-gui program. The following is an example command line
configuration step executed within the build directory:

cmake -G "<generator>" [-D<options>] <sourcepath>

Where <generator> is
* 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

<options> is:
* BUILD_TESTING:BOOL=ON
* BUILD_SHARED_LIBS:BOOL=[ON | OFF]

2. Configure the cache settings

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).
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.

Any conflicts or new values will be highlighted by the configure

process in red. Once you are happy with all the settings and there are
no
more values in red, click the Generate button to produce the appropriate
build files.

On Windows, if you are using a Visual Studio generator, the solution and
project files will be created in the build folder.

On linux, if you are using the Unix Makefiles generator, the Makefiles
will
be created in the build folder.

2.2 Alternative command line example on Windows in c:\MyHDFstuff\hdf5\build

directory:

cmake -G "Visual Studio 12 2013" -DBUILD_TESTING:BOOL=ON ..

3. Build HDF5 Applications

On Windows, you can build HDF5 applications using either the Visual Studio
Environment
or the command line. The command line is normally used on linux, Unix, and
Mac.

To build from the command line, navigate to your build directory and
execute the following:

cmake --build . --config {Debug | Release}

NOTE: "--config {Debug | Release}" may be optional on your platform. We

recommend choosing either Debug or Release on Windows. If you are
using the pre-built binaries from HDF, use Release.

3.1 If you wish to use the Visual Studio environment, open the solution
file in your build directory. Be sure to select either Debug or
Release and build the solution.

4. Test HDF5 Applications

To test the build, navigate to your build directory and execute:

ctest . -C {Debug | Release}

NOTE: "-C {Debug | Release}" may be optional on your platform. We

recommend choosing either Debug or Release to match the build
step on Windows.

5. The files that support building with CMake are all of the files in the
config/cmake folder, the CMakeLists.txt files in each source folder, and
CTestConfig.cmake. CTestConfig.cmake is specific to the internal testing
performed by The HDF Group. It should be altered for the user's
 installation and needs. The cacheinit.cmake file settings are used by
The HDF Group for daily testing. It should be altered/ignored for the user's
installation and needs.

========================================================================
III. Minimum C Project Files for CMake
========================================================================

Given the preconditions in section I, create a CMakeLists.txt file at the

source root. Include the following text in the file:

##########################################################
cmake_minimum_required (VERSION 3.10)
project (HDF5MyApp C CXX)

set (LIB_TYPE STATIC) # or SHARED

string(TOLOWER ${LIB_TYPE} SEARCH_TYPE)

find_package (HDF5 NAMES hdf5 COMPONENTS C ${SEARCH_TYPE})

# find_package (HDF5) # Find non-cmake built HDF5
set_directory_properties(PROPERTIES INCLUDE_DIRECTORIES "${HDF5_INCLUDE_DIR}")
set (LINK_LIBS ${LINK_LIBS} ${HDF5_C_${LIB_TYPE}_LIBRARY})

set (example hdf_example)

add_executable (${example} ${PROJECT_SOURCE_DIR}/${example}.c)

TARGET_C_PROPERTIES (${example} PRIVATE ${LIB_TYPE})
target_link_libraries (${example} ${LINK_LIBS})

enable_testing ()
include (CTest)

add_test (NAME test_example COMMAND ${example})

##########################################################

========================================================================
IV. APPENDIX
========================================================================

Below is an example of a ctest script that can be used to build the examples.
Adjust the values as necessary. Note that the defaults can be entered on the
command line and the build folder is created as a sub-folder. Windows should
adjust the forward slash to double backslashes, except for the HDF_DIR
environment variable.

NOTE: this file is available at the HDF web site:

https://portal.hdfgroup.org/display/support/Building+HDF5+with+CMake

HDF5_Examples.cmake
HDF5_Examples_options.cmake

Also available at the HDF web site is a CMake application framework template.
You can quickly add files to the framework and execute the script to compile
your application with an installed HDF5 binary.
========================================================================
For further assistance, send email to [email protected]
========================================================================