Installation notes

General requirements on Linux/Unix

A compiler: gcc or clang should do.
OpenMP: typically bundled with the compiler.
cmake

A package manager to get the dependencies which are:

Normal build procedure with CMake

To build:

mkdir builddir
cd builddir
cmake ..
cmake --build .
# change the prefix depending on where you want to install the program
cmake --install . --prefix /usr

Without GPU acceleration:

By default dw will be compiled with OpenCL/GPU support enabled (if depencencies are found). If that does not work for you, turn that option off explicitly by passing -DENABLE_GPU=OFF to cmake, i.e. use:

mkdir builddir
cd builddir
cmake -DENABLE_GPU=OFF ..
cmake --build .

Machine specific optimizations

To enable optimizations for your particular machine, pass the option -DENABLE_NATIVE_OPTIMIZATION=ON. Doing that might create binaries that run faster on your machine. However it might not be possible to run the same binaries on another machine.

System wide installation

A direct install (files will be copied to default paths), use:

sudo make install

To use the system package manager is probably the better way since it offers a cleaner way to uninstall:

mkdir builddir
cd builddir
cmake ..
cpack -G DEB # see cpack --help for other types
sudo apt-get install ./deconwolf-0.3.8-Linux.deb # on Ubuntu

GPU Acceleration via OpenCL

If you have more than one OpenCL device, please use the --cldevice n argument to tell deconwolf which device to use. The devices are ordered with 0 being the first. If available use the command clinfo to list the OpenCL devices available on your system.
Under WSL2 and with the current version of pocl it does not seem to work, see issue #56. Hopefully it can work in the future.
If cmake can’t find OpenCL and you are on a cluster, check out: [https://github.com/elgw/deconwolf/issues/55#issuecomment-2137579066]

Platform specific hints

macOS 15.7.2 (mac mini M4)

deconwolf works with GPU acceleration out of the box. The following was required for a build on a fresh system:

Install homebrew. Then, in the terminal install the additional dependencies:

brew install cmake fftw libpng gsl libtiff libomp

When you install libomp please note that it is recommended that you set the following to ~/.zshrc

export OpenMP_ROOT=$(brew --prefix)/opt/libomp
export LDFLAGS="$LDFLAGS -L${OpenMP_ROOT}/lib"

With that set, follow the general build instructions.

Nerd info:

% otool -L ./dw
./dw:
    @rpath/libkdtree.dylib (compatibility version 0.0.0, current version 0.0.0)
    @rpath/libtrafo.dylib (compatibility version 0.0.0, current version 0.0.0)
    /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1351.0.0)
    /opt/homebrew/opt/libtiff/lib/libtiff.6.dylib (compatibility version 9.0.0, current version 9.0.0)
    /opt/homebrew/opt/gsl/lib/libgsl.28.dylib (compatibility version 29.0.0, current version 29.0.0)
    /System/Library/Frameworks/Accelerate.framework/Versions/A/Frameworks/vecLib.framework/Versions/A/libBLAS.dylib (compatibility version 1.0.0, current version 1.0.0)
    /opt/homebrew/opt/libpng/lib/libpng16.16.dylib (compatibility version 67.0.0, current version 67.0.0)
    /opt/homebrew/opt/fftw/lib/libfftw3.3.dylib (compatibility version 10.0.0, current version 10.10.0)
    /opt/homebrew/opt/fftw/lib/libfftw3f.3.dylib (compatibility version 10.0.0, current version 10.10.0)
    /opt/homebrew/opt/fftw/lib/libfftw3f_omp.3.dylib (compatibility version 10.0.0, current version 10.10.0)
    /System/Library/Frameworks/OpenCL.framework/Versions/A/OpenCL (compatibility version 1.0.0, current version 1.0.0)
    /opt/homebrew/opt/libomp/lib/libomp.dylib (compatibility version 5.0.0, current version 5.0.0)
    /usr/lib/libz.1.dylib (compatibility version 1.0.0, current version 1.2.12)

TODO

The CMakeLists.txt needs some attention. As it stands and installation with make install leads to dyld[11935]: Library not loaded: @rpath/libkdtree.dylib.

Windows 10/11

Deconwolf can be built several different ways under Windows:

1. Using WSL, then follow the instructions for Ubuntu. Most likely there will be a performance penalty, and it will not be possible to enable GPU acceleration, see issue #56.

2. msys2 or cygwin, however those options will be slower since OpenMP will be using an pthreads emulation on top of windows threads. It might be possible to get OpenCL working.

3. As a native windows program. This is the preferred way since it also works with GPU acceleration.

To build native windows programs, at least the following software is required:

git
cmake
Visual studio with clang.
vcpkg

The dependencies can get retrieved by vcpkg:

git clone https://github.com/microsoft/vcpkg
.\vcpkg\bootstrap-vcpkg.bat
.\vcpkg\vcpkg.exe install fftw3[threads]
.\vcpkg\vcpkg.exe install tiff
.\vcpkg\vcpkg.exe install gsl
.\vcpkg\vcpkg.exe install opencl
.\vcpkg\vcpkg.exe install getopt
.\vcpkg\vcpkg.exe install libpng
.\vcpkg\vcpkg integrate install

Please note the value of the CMAKE_TOOLCHAIN_FILE, given by the last command, as it will be used later.

A visual studio project can be created by

cd deconwolf
mkdir build
cd build
cmake "-DCMAKE_TOOLCHAIN_FILE=C:/YOUR/OWN/PATH/vcpkg/scripts/buildsystems/vcpkg.cmake" -T ClangCL -A x64 ../

Important: Please use the correct path to vcpkg.cmake.

Open the visual studio solution and go to Linker->Input->Additional dependencies and add:

libomp.lib

Change the build type from debug to release and compile.

Possibly you will have to manually enable vcpkg as well.

If you are a windows developer and reading this, please help us out to make the build process smoother!

To create an installer, see the file util/create_win_dw_installer.nsi.

FreeBSD 14.4

Not tested with GPU support.

Differences to linux: gmake, not make, pkgconf not pkg-config. The default compiler is clang which will not understand all of the GCC directives (expect a few compilation warnings).

Packages:

pkg install git
pkg install gmake
pkg install fftw3
pkg install fftw3-float
pkg install tiff
pkg install gsl
pkg install pkgconf
pkg install cmake

Then proceed as under linux with CMake.

CentOS

Tested on CentOS Linux Release 7.8.2009 (Core).

Dependencies:

sudo yum install gcc gsl-devel libtiff-devel fftw-devel

Ubuntu 16.04

sudo apt-get update
sudo apt-get install gcc
sudo apt-get install pkg-config
sudo apt-get install libfftw3-single3
sudo apt-get install libfftw3-dev
sudo apt-get install openmp
sudo apt-get install libtiff-dev # only difference to 20.04
sudo apt-get install libgsl-dev
sudo apt-get install libomp-dev
sudo apt-get install libpng-dev

Ubuntu 22.04

First install the required packages:

sudo apt-get update
sudo apt-get install \
 cmake               \
 pkg-config          \
 gcc                 \
 libfftw3-single3    \
 libfftw3-dev        \
 libgsl-dev          \
 libomp-dev          \
 libpng-dev          \
 libtiff-dev

Ubuntu 23.04

Same as Ubuntu 22.04. Possibly also

apt-get install opencl-headers

Arch/ Manjaro

# remember to update system
sudo pacman -Suuyy
# install dependencies
sudo pacman -S fftw gsl openmp libtiff

Rapsberry PI (64-bit Debian bookworm)

sudo apt-get update
sudo apt-get upgrade
sudo apt-get install libfftw3-dev \
libtiff-dev \
libgsl-dev

Fedora 20

sudo dnf install cmake fftw-devel gsl-devel libtiff-devel

Replacing standard dependencies

MKL

FFTW3 is the default FFT backend for deconwolf but it is also possible to use Intel MKL. At some point it was possible to choose MKL via

sudo apt install intel-mkl
make MKL=1 -B

To set the number of threads, set the environmental variable MKL_NUM_THREADS, for example:

export MKL_NUM_THREADS=8
dw ...

If you are interested in using MKL please open a new issue.