Documentation

This commit is contained in:
Shahram Najm 2018-12-11 12:16:34 +00:00
parent 599bc2ae33
commit 0c763fc0f8
1 changed files with 10 additions and 1 deletions

11
INSTALL
View File

@ -26,7 +26,7 @@ However it requires that cmake be installed on your system.
4. Run cmake pointing to the source and specify the installation location:
> cmake ../eccodes-x.y.z-Source -DCMAKE_INSTALL_PREFIX=/path/to/where/you/install/eccodes
It is recommended that you install into a clean directory
It is recommended that you always build in a clean directory and also install into a clean directory.
5. Compile, test and install:
> make
@ -35,6 +35,7 @@ However it requires that cmake be installed on your system.
You can also pass options to the cmake command above. Some typical examples are:
-DENABLE_EXTRA_TESTS=ON Enable extended regression testing
-DENABLE_NETCDF=ON Enable GRIB to netCDF conversion
-DENABLE_ECCODES_THREADS=ON Enable POSIX threads
-DENABLE_JPG=ON Enable JPEG encoding/decoding (for GRIB packing)
@ -42,6 +43,14 @@ You can also pass options to the cmake command above. Some typical examples are:
-DCMAKE_C_FLAGS="-O2 -Wall" Prepend the specified flags at the front
of the compilation command for C source files
By default the ctest step above 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:
> cmake ... -DENABLE_EXTRA_TESTS=ON
In this mode the tests will take longer and you need to be connected to the internet so data files can be downloaded
for the tests.
For more details, please see:
https://software.ecmwf.int/wiki/display/ECC/ecCodes+installation