Table of Contents |
---|
Info |
---|
Note: this guide provides information on how to build Metview from source. Please consider installing a pre-built version, as described in the Releases page. |
Overview
Overview
From version 4.5, Metview uses CMake for its compilation and installation. This is part of the process of homogenising the installation procedures for all ECMWF packages.
As with configure, CMake will run some tests on the system to find out if required third-party software libraries are available and notes their locations (paths). Based on this information it will produce the Makefiles needed to compile and install Metview.
CMake is a cross-platform free software program for managing the build process of software using a compiler-independent method.
Requirements
Platforms
At ECMWF, openSUSE 11.3, openSUSE 13.1, SLES 11 and Red Hat 6 Linux systems (64bit) were used for the regular usage and testing of Metview. Other Linux platforms are used for occasional testing.
ECMWF support libraries
All required support libraries from ECMWF are available without charge from the Software Services web page:
To produce plots, Magics must be installed:
Magics++ (2.22 or higher is required)
...
for a 'pure batch' installation of Metview with no user interface, it is possible to supply Magics with the option -DENABLE_METVIEW_NO_QT
The following two libraries need to be installed (both are required, even if you will not handle GRIB or BUFR data):
GRIB_API (1.9.9 or higher)
see the Installation FAQ for details of building GRIB_API for Metview, as this contains some important information
version 392 or higher
compiled with double floating point precision (answer “y” to “Do you want 64-bit reals? [y,n]”)
must be built with GRIB_API support
64-bit versions should be built with -fPIC compilation flag
- Remember to set the ARCH environment variable before building Emoslib, e.g.
export ARCH=linux
.
Info |
---|
The latest versions of EmosLib depend on GRIB_API, therefore GRIB_API must be installed before EmosLib. |
Required third-party software
First, ensure that all third-party libraries required by Magics and GRIB_API are installed (this is likely to have been fulfilled already unless Magics was built on another system and copied across).
Additionally, the following list of software should be installed on your system before you try to install Metview. If you use a package manager, such as RPM, to install software make sure to include the corresponding development packages with the header files. CMake will test for these libraries and give error messages if an essential one is missing.
...
, in line with all other ECMWF packages. Note that there are other ways to install Metview from pre-built binary packages, or from a source bundle that includes many dependencies. See Releases.
Include Page | ||||
---|---|---|---|---|
|
Requirements to build Metview
The following table lists the dependencies Metview requires to be built from source. Please note, if you install these package from source you also might have to install the respective "-devel" packages.
Compilers | |||
---|---|---|---|
C++ | http://gcc.gnu.org/ | ||
Fortran | http://gcc.gnu.org/fortran/ | ||
Utilities | |||
make | http://www.gnu.org/software/make/ | ||
Third party packages (best installed through system package manager) | |||
Qt 5 | http://www.qt.io/ | if Metview's user interface is required. Note |
...
that on some systems it is also necessary to install the libQtWebKit-devel development package (it may have different names on different systems) |
...
...
OpenMotif (if enabling the old user interface with -DENABLE_MOTIF)
...
gdbm
...
Please note: You also will need to install HDF5 and the legacy C++ interface if you wish to run the Single Column Model from Metview (ECMWF only) | |||
curl | Optional for web services support (WMS, Download module) | ||
bison | |||
flex | |||
ECMWF libraries | |||
---|---|---|---|
ecCodes | ecCodes Home | ||
magics | Magics | if plotting support is needed. Note that Magics should be configured with the -DENABLE_METVIEW=ON option. For a 'pure batch' installation of Metview with no user interface, it is possible to supply Magics with the option -DENABLE_METVIEW_NO_QT=ON | |
odc | ODC Home / ODB-API Home | if ODB support needed | |
emoslib | EMOS | optional and deprecated |
If you wish to access OPERA radar BUFR data, then you will need to also install the proj4 development libraries.
Compilation environment
Any C++ Compiler which supports features required for the ANSI C++ standard from 1998 (STL, namespaces, templates) should work with Metview. At ECMWF we tested GCC’s g++ 4.1, 4.3 and 4.5 successfully. A Fortran compiler is required to build some of Metview's modules. It will also be required to build EmosLib, for which Cray pointer support is required. At ECMWF the Portland Pgf90 compiler 7.2 and GFortran 4.5 and newer were tested successfully on Linux platforms.
Notes for installers of Metview 3
If you have installed Metview 3 before, then here are some things to note. Metview 4 does not use directly OpenGL for its on-screen graphics; therefore, it is not necessary to build your own Mesa library anymore. However, Metview 4 does not come with its own Emoslib; therefore, it will be necessary to install your own.
Metview 4 can be installed side-by-side with an existing Metview 3 installation. However, note that the default startup script will be
/usr/local/bin/metview
so make sure this will not clash with an existing installation. See Compilation and installation on page 6 for details of flags which will allow you to change this.
Compilation and installation
It is advisable to perform an 'out-of-source build', meaning that the build should take place in a directory separate from where the source code is. Here is an example set of commands to set up and build Metview using default settings:
Code Block | ||
---|---|---|
| ||
# unpack the source tarball into a temporary directory
mkdir -p /tmp/src
cd /tmp/src
tar xzvf Metview-4.5.0-Source.tar.gz
# configure and build in a separate directory
mkdir -p /tmp/build
cd /tmp/build
cmake /tmp/src/Metview-4.5.0-Source
make |
Although it is possible to run Metview directly from the build directory, it is best to install it. The installation directory is /usr/local
by default, but can be changed by adding the -DCMAKE_INSTALL_PREFIX flag to the cmake command. In this case, the configure, build and install step would look like this:
Code Block | ||
---|---|---|
| ||
cmake /tmp/src/Metview-4.5.0-Source -DCMAKE_INSTALL_PREFIX=/path/to/metview_install_dir
make
make install |
CMake options used in Metview
CMake options are passed to the cmake
command by prefixing them with -D, for example -DENABLE_UI=OFF.
CMake option | Description | Default |
---|
to select the type of compilation:
- Debug
- RelWithDebInfo
- Release
- Production
In most cases Release is preferable for an optimised version with no debug information
ENABLE_UI | enables the Qt-based user interface | ON |
ENABLE_ |
enables the deprecated Motif-based user interface
- Metview can be started with option -old-ui
PLOTTING | enables plotting capabilities using |
MAGP | ON |
ENABLE_ |
METVIEW_ |
FORTRAN | enables |
inline Fortran code inside macros | OFF (since Metview 5.10.2) |
ENABLE_MARS | enables MARS access (not required if using through the Web API) | OFF |
MARS_LOCAL_HOME | sets the path to where local |
MARS is installed |
ENABLE_ODB | enables processing and plotting of ODB data | OFF |
ENABLE_MARS_ODB | enables ODB capabilities in MARS client | OFF |
ENABLE_USAGE_LOG | enables logging of Metview startup calls | OFF |
LOG_DIR | path to where to log the Metview startup calls |
ENABLE_METVIEW_FORTRAN | enables inline Fortran code inside macros | OFF (since Metview 5.10.2) |
METVIEW_SCRIPT | name of the generated Metview startup script | metview |
EXTRA_CONFIG_PATH | path to optional directory containing metview_local* script files | |
ENABLE_QT_DEBUG | outputs additional log messages from Qt-based modules | OFF |
EXTRA_TITLE | build-specific title to add to the log |
entries | ||
ENABLE_INPE | enables INPE modules | OFF |
Path options - only required when support libraries are not installed in default locations | ||
CMake Option | Description | Notes |
---|
ECCODES_PATH | path to where |
ecCodes has been installed |
MAGICS_PATH | path to where Magics has been installed | Only required if plotting is enabled |
NETCDF_PATH | path to where netCDF has been installed |
ODC_PATH | path to where |
ODC has been installed | Only required if ODB is enabled | |
ODB_PATH | path to where the original ODB has been installed | Optional if ODB is enabled |
EMOS_PATH | path to where Emoslib has been installed | Also set EMOS_LIB_NAME |
FDB_PATH | path to where fdb has been installed | Only required if MARS is enabled |
FLEXTRA_PATH | path to where |
the FLEXTRA executable has been installed |
See Tutorials for more on FLEXTRA |
Notes for installers of Metview 3
If you have installed Metview 3 before, then here are some things to note. Metview 5 does not use directly OpenGL for its on-screen graphics; therefore, it is not necessary to build your own Mesa library anymore.
Metview 5 can be installed side-by-side with an existing Metview 3 installation. However, note that the default startup script will be
/usr/local/bin/metview
so make sure this will not clash with an existing installation. See the table of CMake options for the flag which will allow you to change this.
FAQ
See also the Installation FAQ.