INSTALL

   1 Getting libaec
   2 ==============
   3
   4 The source code of libaec is hosted at DKRZ GitLab.
   5
   6 ## Source code and binary releases
   7
   8 The latest releases of libaec can be downloaded at the following
   9 location:
  10
  11   https://gitlab.dkrz.de/k202009/libaec/tags
  12
  13 ## Developer snapshot
  14
  15   git clone https://gitlab.dkrz.de/k202009/libaec.git
  16
  17
  18 Installation
  19 ============
  20
  21 ## General considerations
  22
  23 Libaec achieves the best performance on 64 bit systems. The library
  24 will work correctly on 32 bit systems but encoding and decoding
  25 performance will be much lower.
  26
  27 ## Installation from source code release with configure
  28
  29 The most common installation procedure on Unix-like systems looks as
  30 follows:
  31
  32 Unpack the tar archive and change into the unpacked directory.
  33
  34   mkdir build
  35   cd build
  36   ../configure
  37   make check install
  38
  39 ## Installation from source code release with CMake
  40
  41 As an alternative, you can use CMake to install libaec.
  42
  43 Unpack the tar archive and change into the unpacked directory.
  44
  45   mkdir build
  46   cd build
  47   cmake ..
  48   make install
  49
  50 You can set options for compiling using the CMake GUI by replacing the cmake
  51 command with
  52
  53   cmake-gui ..
  54
  55 or by setting the options manually, e.g.
  56
  57   cmake -DCMAKE_INSTALL_PREFIX=~/local ..
  58
  59 in order to set the install prefix to ~/local
  60
  61 CMake can also generate project files for Microsoft Visual Studio when
  62 used in Windows.
  63
  64 ## Installation from cloned repository
  65
  66 The configure script is not included in the repository. You can
  67 generate it with autotools:
  68
  69   cd libaec
  70   autoreconv -iv
  71   mkdir build
  72   cd build
  73   ../configure
  74
  75 Also not included are CCSDS sample data which are needed for
  76 testing. They have to be downloaded prior to running 'make check':
  77
  78   make update-sampledata
  79   make check install
  80
  81
  82 Intel compiler settings
  83 =======================
  84
  85 The Intel compiler can improve performance by vectorizing certain
  86 parts of the code on x86 architectures. Assuming your CPU supports
  87 AVX2, the following options will increase encoding speed.
  88
  89   ../configure CC=icc
  90   make CFLAGS="-O3 -xCORE-AVX2" bench
  91
  92 On a 3.4 GHz E3-1240 v3 we see more than 400 MiB/s for encoding
  93 typical data.
  94
  95 Using other SIMD instruction sets on older CPUs may also help.