Versions Compared

Old Version 66

changes.mady.by.user Shahram Najm

Saved on

compared with

New Version Current

changes.mady.by.user Shahram Najm

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Overview

ecCodes uses CMake for compilation and installation. This is a first step towards an homogenisation of the installation procedures for all ECMWF packages.

...

One nice and highly recommended feature of CMake is the ability to do out of source builds. In this way you can make all your ".o" files, various temporary depend files, and even the binary executables without cluttering up your source tree. To use out of source builds, first create a build directory, then change into your build directory and run cmake pointing it to the source directory and using your own options.

...


CMAKE_INSTALL_PREFIXwhere you want to install your ecCodes/usr/local
CMAKE_BUILD_TYPE

to select the type of compilation:

  • Debug
  • RelWithDebInfo
  • Release
RelWithDebInfo
BUILD_SHARED_LIBSSelect the type of library built:
  • ON (Build shared libraries only)
  • OFF (Build static libraries only)
  • BOTH (Build both shared and static libraries)
ON
CMAKE_CCXX_COMPILERC++ Compiler
CMAKE_CCXX_FLAGSFlags for the C++ Compiler
CMAKE_Fortran_COMPILERFortran Compiler
CMAKE_Fortran_FLAGSFlags for the Fortran Compiler
ENABLE_NETCDFFor the grib_to_netcdf conversion toolON
ENABLE_JPG

Enable JPEG2000 support. This option should look for Jasper JasPer or OpenJPEG.
If this option is enabled it is also possible to pick which one of OpenJPEG or Jasper JasPer to use:

  -DENABLE_JPG_LIBOPENJPEG=ON
  -DENABLE_JPG_LIBJASPER=ON

ON

ENABLE_PNGEnable PNG support for decoding/encodingOFF
ENABLE_AECEnable Adaptive Entropy Coding (AEC) for GRIB decoding/encoding (CCSDS)ON
ENABLE_PYTHON2Offers the Python interface to the package.

Note: This option is

only for Python 2 (now deprecated)

 deprecated and was removed in Q1 2023.

The Python2 interface to the package.
For Python 3 use "pip3 install"

.

(See below)

OFFN/A
ENABLE_FORTRANOffers the Fortran 90 interface to the packageON
ENABLE_ECCODES_THREADSEnable thread-safety using POSIX threadsOFF
ENABLE_ECCODES_OMP_THREADSEnable thread-safety using OpenMP threadsOFF
ENABLE_MEMFSSee Memory based access to definition/sample files
Note: When this is enabled, the sample files and definitions are not installed.
To install them, add:
  -DENABLE_INSTALL_ECCODES_DEFINITIONS=ON
  -DENABLE_INSTALL_ECCODES_SAMPLES=ON		OFF
ENABLE_EXTRA_TESTSEnable extended regression testing (which requires data downloads)OFF
cmake options
doc
default


Note: The compilers can also be overridden by setting the environment variables CC CXX and FC.

Note: To see the full output from the compilation, you can use:

   make VERBOSE=1

Quick installation guide

Here is an example of a list of commands you could use to install ecCodes.  It is assumed “>” is the shell prompt.
First of all get the tarball "eccodes-x.y.z-Source.tar.gz" from our Releases page. Then:

Code Block
> tar -xzf  eccodes-x.y.z-Source.tar.gz
> mkdir build ; cd build 

> cmake -DCMAKE_INSTALL_PREFIX=/path/to/where/you/install/eccodes ../eccodes-x.y.z-Source 
...

> make
> ctest
> make install


It is recommended that you always build in a clean directory and also install into a clean directory.

By default the ctest step above (running the tests) does NOT require any data to be downloaded and only runs basic sanity tests. However if you wish to exercise more of the functionality of ecCodes, you are advised to configure the build with:

Code Block
> cmake ...  -DENABLE_EXTRA_TESTS=ON

In this mode the tests will take longer and you need to be connected to the internet (and set the relevant "http_proxy" environment variable if you must use a proxy) so data files can be downloaded for the tests. You can however download all the data files in one go (See the data tarball link at the top of the Releases page)

...

The Python 3 bindings are now built with CFFI and are packaged separately. So first install ecCodes as above with a shared library (either BUILD_SHARED_LIBS=ON or BOTH) and then install from PyPI:


Code Block
> pip3 install eccodes

or

Code Block
> pip3 install --install-option="--prefix=/path/to/where/you/install/eccodes" eccodes

If you are installing into a non-standard installation location (as in the 2nd case above), then set the environment variable ECCODES_DIR to tell the bindings where to find the root installation directory of the ecCodes engine.

Code Block
> export ECCODES_DIR=/path/to/where/you/install/eccodes



See: https://pypi.org/project/eccodes/

...

If you find problems, we invite the Windows user community to use our new set-up on GitHub to fork/contribute and issue pull request changes. Old Reliable Tech has set up automatic tests and builds for Windows on GitHub, which should ensure continued releases for this new platform.

Legacy build system ("autotools")

From ecCodes version 2.0.0 the "autotools" build system is deprecated and no longer supported.