...
Section | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Before you start
Decide where you will put the grib_api package.
...
In the walk-through example that follows, a single-user download and install is assumed.
Download and unpack
Create a directory called $HOME/ecmwf
in which grib-api will be downloaded and compiled.
If you haven't already obtained the grib_api package, get it from the grib-api web site. We recommend downloading the latest version. Some of the instructions for options below may differ with the very latest versions.
Unpacking grib_api
To unpack the software:
Code Block | ||||
---|---|---|---|---|
| ||||
mkdir -p ecmwf/src cd ecmwf/src tar zxf grib_api-1.14.0-Source.tar.gz |
...
Code Block |
---|
gunzip grib_api_1.14.0.tar.gz tar xf grib_api-1.14.0.tar |
Configuring compilation using autotools
Grib_api compilation can be made using the GNU configure tool. This will be familiar to many who have previously installed software.
...
The configure command is contained in the grib_api directory. A few options are needed to suit the OpenIFS models and gcc & gfortran compilers are assumed in the example below. If you use different compilers, see below.
...
A description of what these options are for:
--prefix | This specifies where you want the grib_api files to be installed. In example here, the source code is in $HOME/ecmwf/grib_api_1.14.0-Source and the compiled grib_api libraries will go in directory $HOME/ecmwf/grib_api . You are free to choose any installation directory but it's recommended to keep the installed binaries & libraries in a separate directory to the source code, in case different compiler versions are needed. On a shared high performance computer facility, the install path would most likely be somewhere central. If nothing is specified for --prefix , by default grib_api will install in /usr/local . |
--disable-jpeg | OpenIFS |
models do not need to support JPEG and PNG for data compression. This removes the need to link |
against the Jasper library (libjasper.a). | |
--enable-pthread | This option ensures that grib_api is thread-safe and is a recommended option. |
--enable-python | This option is not essential but desireable. It enables the python interface and is required as some |
utilities make use of the grib-api python interface. If the make fails because of a missing numpy header file you should add the --disable-numpy option. If this option does not work, some of the tools provided with OpenIFS models may not work. |
Other options
--help
option to configure can be used to see what other options are possible, also see the grib_api website for more detailed documentation.
...
--disable-numpy
option should be used if python is enabled but configure can't find the NumPy package.
Shared and static libraries
grib_api will build both shared and static libraries by default. Shared libraries may need to be built if the python interface is used, depending on your installation.
...
IBM users may find that the grib-api fortran tests will fail unless --disable-shared is used.
Configuring using CMake
Grib_api uses the CMake command for configuration and compilation. CMake is available for modern Linux systems but may have to be installed.
...
Explanation of lines. Note that all options are prefixed by '-D':
| These lines set the choice of compiler. CMake is often able to determine the available compilers for itself. However, in cases where multiple compilers are available, or where compiler wrappers are used (as on HPC systems), it's preferable to set these explicitly by use of environment variables. These lines can often be omitted. |
CMAKE_INSTALL_PREFIX="../grib_api" | This specifies the location where the 'make install' command will place the grib-api installation. |
ENABLE_NETCDF=ON | Enabling netcdf ensures the grib_to_netcdf command can be used. |
ENABLE_JPG=OFF ENABLE_PNG=OFF | As OpenIFS |
models do not deal with any image based GRIB data these options can be disabled, unless you have other grib data containing images that you need to work with. | |
ENABLE_PYTHON=ON | Some of the utilities that come with OpenIFS models make use of the python interface to grib_api, e.g. the tools to create and manipulate the model data. For this option to work, ensure that a python installation is available. |
ENABLE_FORTRAN=ON | This enables the Fortran interface to grib_api and should always be on. |
ENABLE_GRIB_THREADS=ON | This ensures grib_api is compiled to be 'thread-safe'. Although OpenIFS |
models do not currently use multiple threaded calls to grib-api, future versions may do so this option is recommended. | |
BUILD_SHARED_LIBS=OFF | grib_api can be built with both 'shared' and 'static' libraries for linking. Normally static libraries are sufficient. Note that some IBM users may experience problems if shared libraries are built. |
Available options
To get additional help on the available options (similar to the 'configure --help' command) run the command:
...
Info |
---|
This command will cause cmake to run its system discovery if this is the first time the command has been used. On some systems, this may take time to complete. |
Choice of compiler and options
By default, cmake and configure will use the preferred compiler and set appropriate compiler options accordingly (for cmake, this depends on the build type).
...
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Compiling, checks and installing
After configuration the next steps are to compile grib-api and install it. To compile grib_api do:
...
After this stage, next steps are to download and install FCM and then download the OpenIFS code and accompanying files.
Possible problems
Info | ||
---|---|---|
| ||
OpenIFS support: openifs-support@ecmwf.int. |
Cray
Possible issues with the Cray systems (using cce or gnu compilers) are related to building shared libraries and linking with supporting netcdf and python libraries.
...
LIBRARY_PATH
is only used at compile/link time. It may also be necessary to add this directory to the LD_LIBRARY_PATH
environment variable which is searched for libraries at runtime.
Intel compiler
We currently recommend not using a higher optimization level than -O1 with the Intel compiler. Failures have been seen with grib_api and the Intel compiler when compiled with -O2.
Some versions of the Intel compiler (v14.0.x) can produce an error "unknown option -soname" when using 'configure. If this occurs try using "--disable-shared" or try the cmake command instead.
IBM compiler
For the IBM xlc compiler we recommend disabling the creation of 'shared libraries' which is known to cause problems with some versions of grib_api.
In this example, note the use of the '_r' form of the IBM compiler to ensure grib_api is compiled 'thread-safe'.
Building on High Performance Computer Systems
Info |
---|
Some HPC batch systems have a different hardware architecture for their login (or frontend node) to the batch node, but the frontend compilation system is targeted at the batch nodes. This is known as cross-compilation. If this is the case you may see failures in the 'make check' stage because the checks, although compiled for the backend batch nodes, are being run on the frontend nodes and therefore may not work correctly. If this is the case on your system, we recommend using a batch job to do the 'configure; make; make check; make install' steps. In some cases, the batch system cannot be used for compilation at all. In this case, you have to compile on the frontend but without extra flags 'configure' will assume the build is for the frontend. You can make use of the --host option to ensure the build is correct for the architecture of the batch system. Again though, the tests will fail, a small serial batch job is recommended to make sure grib_api is installed correctly. Note if you plan on using the grib_api software in your own software that runs on the frontend nodes you will need to install grib_api twice; one for the batch system and again for the frontend system. If you have any questions installing grib_api in this type of environment, please contact: openifs-support@ecmwf.int for assistance. |
Verify the installation
To verify that the installation was successful, first ensure that the grib_api bin directory is added to your PATH environment variable and then run the grib_info command e.g.
...