aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
blob: d717e97abe1b3c9aac24a4d1d81a352313f76661 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
Required dependencies:
======================

    * Boost 1.41 or later
    * Optional ZeroMQ http://www.zeromq.org
        Use --disable-input-zeromq if you don't have it
    * Optional FFTW 3.x (KISS FFT is default)
        Enable with --enable-fftw

Simple install procedure:
=========================

    % tar xjf odr-dabmod-X.Y.Z.tar.bz2      # Unpack the source
    % cd odr-dabmod-X.Y.Z                   # Change to the source directory
    % ./configure --disable-debug --with-debug-malloc=yes --enable-fft-simd
                                            # Run the configure script
    % make                                  # Build ODR-DabMod
    [ as root ]
    % make install                          # Install ODR-DabMod

Configure options
=================
The configure script can be launch with a variety of options:

 --enable-input-zeromq  Enable ZeroMQ input (to be used with ODR-DabMux)
 --enable-output-uhd    Includes the binding to the UHD driver for USRPs

You have the choice between two FFT libraries: KISS FFT and FFTW. KISS FFT is a
proven library, but it's performance is worse than with the new FFTW. With the
default KISS FFT, you have the choice between using the normal version, or the
SIMD accelerated version, which is a bit faster. The corresponding options are:

 --enable-fftw          Use FFTW3 instead of KISS FFT (experimental, better performance)
 --enable-fft-simd      Enable SIMD instructions for KISS FFT

Debugging options: You should disable debug to improve ODR-DabMod performance.
By default, debug is enabled.
 --disable-debug        Do not compile with debugging, and enable optimisations
 --enable-trace         Create debugging files for each DSP block for data analysis

For more information, call:

    % ./configure --help

Nearly as simple install procedure using repository:
====================================================

    * Download and install fec as above
    * Clone the git repository
    * Bootstrap autotools:
        % ./bootstrap.sh
            In case this fails, try one of the following:
        % aclocal && automake --gnu --add-missing && autoconf
            or
        % autoreconf
    * Then use ./configure as above