ODIM (HDF5 format) Support Library

This library implements classes which ease the task of reading and writing HDF5 files which conform to the OPERA Data Information Model (ODIM) standard.

More information on ODIM may be found at http://www.eumetnet.eu/opera

Installation

To build and install the library use CMake to generate Makefiles. For an install to the standard locations on a linux system run the following commands from the root of the source distribution:

mkdir build
cd build
cmake ..
make
sudo make install

To install to a non-standard prefix (eg: ${HOME}/local) modify the cmake line as such:

mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=${HOME}/local
make
sudo make install

Packaging

To build distribution packages of the library use CPack. Pass the name of the package generator you wish to use via the -G argument. Currently only the RPM generator is officially supported:

mkdir build
cd build
cmake ..
cpack -G RPM

Note that RPM packaging requires CMake 3.6 or better.

Integrating with your project

To use the library within your project it is necessary to tell your build system how to locate the correct header and shared library files. Support for discovery by CMake and pkg-config (and therefore autotools) is included.

Via CMake

To use the library within your CMake based project, simply add the line

find_package(odim_h5)

to your CMakeLists.txt. This function call will set the variables ODIM_H5_INCLUDE_DIRS and ODIM_H5_LIBRARIES as needed. A typical usage scenario is found below:

find_package(odim_h5 REQUIRED)
include_directories(${ODIM_H5_INCLUDE_DIRS})
add_executable(foo foo.cc)
target_link_libraries(foo ${ODIM_H5_LIBRARIES})

Via pkg-config

To discover compilation and link flags via pkg-config use the following commands:

pkg-config --cflags odim_h5
pkg-config --libs odim_h5

A typical usage scenario is found below:

g++ -o foo $(pkg-config --cflags --libs odim_h5) foo.cc

If pkg-config cannot find the odim_h5 package, ensure that you have set your PKG_CONFIG_PATH environment variable correctly for the install prefix which installed the library to. For example, in the ${HOME}/local example above the following will set the correct PKG_CONFIG_PATH:

export PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:${HOME}/local/lib/pkgconfig

C++ compatibility note

The library is written in C++11. It will not compile on compilers that lack support for this version of C++ or later. Depending on your compiler you may need to explicitly enable C++11 support by adding the -std=c++11 flag.

For example:

g++ -std=c++11 -o foo $(pkg-config --cflags --libs odim_h5) foo.cc

Using the API

Please consult the odim_h5.h header for examples on how to use the API within your code.

License

This library is open source and made freely available according to the below text:

Copyright 2016 Commonwealth of Australia, Bureau of Meteorology

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

A copy of the license is also provided in the LICENSE file included with the source distribution of the library.