Installation on Linux¶
Building from source¶
UFO has only a few hard source dependencies, namely
- GLib 2.0,
- JSON-GLib 1.0 and
- a valid OpenCL installation.
Furthermore, it is necessary to build the framework with a recent version of CMake. Sphinx is used to create this documentation.
OpenCL development files must be installed in order to build UFO. However, we cannot give general advices as installation procedures vary between different vendors. However, our CMake build facility is in most cases intelligent enough to find header files and libraries for NVIDIA CUDA and AMD APP SDKs.
Ubuntu/Debian¶
On Debian or Debian-based system the following packages are required to build ufo-core:
$ sudo apt-get install build-essentials cmake libglib2.0-dev libjson-glib-dev
You will also need an OpenCL ICD loader. To simply get the build running, you can install
$ sudo apt-get install ocl-icd-opencl-dev
Generating the introspection files for interfacing with third-party languages such as Python you must install
$ sudo apt-get install gobject-introspection libgirepository1.0-dev
and advised to install
$ sudo apt-get install python-dev
To use the ufo-mkfilter
script you also need the jinja2 Python package:
$ sudo apt-get install python-jinja2
Building the reference documentation and the Sphinx manual requires:
$ sudo apt-get install gtk-doc-tools python-sphinx
Additionally the following packages are recommended for some of the plugins:
$ sudo apt-get install libtiff5-dev
openSUSE¶
For openSUSE the following packages should get you started:
$ zypper install cmake gcc gcc-c++ glib2-devel json-glib-devel
Additionally the following packages are recommended for some of the plugins:
$ zypper install libtiff-devel
Retrieving the source code¶
In an empty directory, issue the following commands to retrieve the current unstable version of the source:
$ git clone https://github.com/ufo-kit/ufo-core
$ git clone https://github.com/ufo-kit/ufo-filters
The latter is used for developers who have write-access to the corresponding repositories. All stable versions are tagged. To see a list of all releases issue:
$ git tag -l
System-wide installation¶
If you have root access on the build machine, you can install the libraries and tools system-wide so that every user can access them.
Building ufo-core¶
Change into another empty build directory and issue the following commands to configure
$ cmake <path-to-ufo>
CMake will notify you, if some of the dependencies are not met. In case you want to install the library system-wide on a 64-bit machine you should generate the Makefiles with
$ cmake -DCMAKE_INSTALL_LIBDIR=/usr/lib64 <path-to-ufo>
For earlier versions of PyGObject, it is necessary that the introspection files
are located under /usr
not /usr/local
. You can force the prefix by
calling
$ cmake -DCMAKE_INSTALL_PREFIX=/usr <path-to-ufo>
Last but not least build the framework, introspection files, API reference and the documentation using
$ make
You should now run some basic tests with
$ make test
If everything went well, you can install the library with
$ make install
You can also build RPM
and DEB
packages with
$ make package
and source tarballs with
$ make package_source
See also
Building ufo-filters¶
Once ufo-core is installed you can build the filter suite in a pretty similar way
$ mkdir -p build/ufo-filters
$ cd build/ufo-filters
$ cmake <path-to-ufo-filters> -DLIBDIR=/usr/lib64 -DPREFIX=/usr
$ make
$ make install
Python support¶
ufo-core has GObject introspection to let third-party languages interface with
the library. To build the support files you need the GObject introspection
scanner g-ir-scanner
and compiler g-ir-compiler
which you can get on
openSUSE via
$ zypper install gobject-introspection-devel python-gobject2
In the python/
subdirectory of the source distribution, additional Python
modules to interface more easily with the framework is provided. To install the
NumPy module and the high-level interface run
$ cd python/ && python setup install
Refer to the README for additional information.
Installing into non-standard directories¶
It is possible to install the library in a non-standard directory, for example
in the home directory of a user. In case we want to install in ~/tmp/usr
, we
have to configure ufo-core like this
$ mkdir -p build/ufo-core
$ cd build/ufo-core
$ cmake <path-to-ufo> -DCMAKE_INSTALL_PREFIX=/home/user/tmp/usr
$ make && make install
Now, we have to adjust the pkg-config
path, so that the library can be
found when configuring the filters
$ export PKG_CONFIG_PATH=/home/user/tmp/usr/lib/pkgconfig
$ mkdir -p build/ufo-filters
$ cd build/ufo-filters
$ cmake <path-to-ufo-core> -DCMAKE_INSTALL_PREFIX=/home/user/tmp/usr
$ make && make install
After installation you have to set the typelib and linker path so that everything is found at run-time
$ export GI_TYPELIB_PATH=/home/user/tmp/usr/lib/girepository-1.0
$ export LD_LIBRARY_PATH=/home/user/tmp/usr/lib:$LD_LIBRARY_PATH