From 15ae2b475ad80ca4b18c860a1732b0395b3bb0c3 Mon Sep 17 00:00:00 2001 From: Shahram Najm Date: Thu, 30 Jul 2015 13:47:16 +0100 Subject: [PATCH] Updated the top-level text files with installation info etc --- AUTHORS | 3 +-- ChangeLog | 1 - INSTALL | 52 +++++++++++++++++++++++++--------------------------- README | 36 ++++++++++++++++++------------------ 4 files changed, 44 insertions(+), 48 deletions(-) diff --git a/AUTHORS b/AUTHORS index 91876dd20..28d6b0e1a 100755 --- a/AUTHORS +++ b/AUTHORS @@ -1,7 +1,6 @@ Enrico Fucile Shahram Najm Sandor Kertesz -Baudoin Raoult +Baudouin Raoult Cristian Codorean Jean-Baptiste Filippi - diff --git a/ChangeLog b/ChangeLog index 1c3c419a8..579db95fd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,4 +2,3 @@ The changelog is now online. Please see: https://software.ecmwf.int/wiki/display/ECC/History+of+Changes - diff --git a/INSTALL b/INSTALL index c7de8fae5..b0d2e3f2c 100644 --- a/INSTALL +++ b/INSTALL @@ -1,39 +1,37 @@ +How to build and install ecCodes library/tools +================================================ -The ecCodes installation is based on the standard configure utility. -It is tested on several platforms and with several compilers. However for some platforms -modifications to the installation engine may be required. If you encounter any problem -during the installation procedure please send an e-mail with your problem to -Software.Support@ecmwf.int. +Building and installation has been tested on several platforms and with several compilers. +However for some platforms modifications to the installation engine may be required. +If you encounter any problems during the installation procedure please send an e-mail +with your problem to: -The only required package for a standard installation is jasper which enables the jpeg2000 -packing/unpacking algorithm. -It is possible to build ecCodes without jasper, by using the --disable-jpeg configure option, -but to install a fully functional library, its download is recommended. + Software.Support@ecmwf.int -Standard Installation -===================== +Installation using CMake +------------------------ +This is the recommended method of installation. +However it requires that cmake be installed on your system. - 1. Download eccodes from https://software.ecmwf.int/wiki/display/ECC/Releases. - 2. Unpack distribution: +1. Download ecCodes from https://software.ecmwf.int/wiki/display/ECC/Releases - > tar xzf eccodes-X.tar.gz +2. Unpack distribution: + > tar -xzf eccodes-x.y.z-Source.tar.gz - 3. Create a separate directory where to build eccodes +3. Create a separate directory where to build ecCodes: + > mkdir build + > cd build - > mkdir build ; cd build +4. Run cmake pointing to the installation location: + > cmake ../eccodes-x.y.z-Source -DCMAKE_INSTALL_PREFIX=/path/to/where/you/install/eccodes - 4. Run cmake +5. make, check and install: + > make + > make check + > make install - > cmake ../eccodes-X -DCMAKE_INSTALL_PREFIX=/path/to/where/you/install/eccodes - 5. make, check and install +For more details, please see: +https://software.ecmwf.int/wiki/display/ECC/ecCodes+installation - > make - ... - > make check - ... - > make install - ... - -For further details, see: https://software.ecmwf.int/wiki/display/ECC/ecCodes+installation diff --git a/README b/README index 961d7d586..fe673c603 100644 --- a/README +++ b/README @@ -1,36 +1,36 @@ ecCodes is the ECMWF encoding/decoding software for GRIB and BUFR. Documentation can be found here: -https://software.ecmwf.int/wiki/display/ECC/ecCodes+Home + https://software.ecmwf.int/wiki/display/ECC/ecCodes+Home -INSTALLATION +INSTALLATION +------------ - 1. Download eccodes from https://software.ecmwf.int/wiki/display/ECC/Releases. - 2. Unpack distribution: +1. Download ecCodes from https://software.ecmwf.int/wiki/display/ECC/Releases - > tar xzf eccodes-X.tar.gz +2. Unpack distribution: + > tar -xzf eccodes-x.y.z-Source.tar.gz - 3. Create a separate directory where to build eccodes +3. Create a separate directory where to build ecCodes: + > mkdir build + > cd build - > mkdir build ; cd build +4. Run cmake pointing to the installation location: + > cmake ../eccodes-x.y.z-Source -DCMAKE_INSTALL_PREFIX=/path/to/where/you/install/eccodes - 4. Run cmake +5. make, check and install: + > make + > make check + > make install - > cmake ../eccodes-X -DCMAKE_INSTALL_PREFIX=/path/to/where/you/install/eccodes - 5. make, check and install +For more details, please see: +https://software.ecmwf.int/wiki/display/ECC/ecCodes+installation - > make - ... - > make check - ... - > make install - ... - -For further details, see: https://software.ecmwf.int/wiki/display/ECC/ecCodes+installation COPYRIGHT AND LICENSE +---------------------- Copyright 2005-2015 ECMWF.