Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 2.33 KB

installation.md

File metadata and controls

82 lines (56 loc) · 2.33 KB

Installation

Dependencies

Make sure you have installed on your system the essential list of dependencies for building and running the complete node.gl stack:

  • GCC or Clang
  • GNU/Make
  • FFmpeg (and its libraries for compilation)
  • Python 3.x (you will need the package with the build headers as well, typically named with a -devel suffix on Debian based systems)
  • pip (Python 3 version)
  • Graphviz
  • SDL2

Quick user installation

The following steps describe how to install node.gl and its dependencies in your home user directory, without polluting your system (aside from the system dependencies which you should install and remove in sane ways).

For a fast ready-to-go user experience, you can use the default rule of the root Makefile. Calling make in the root directory of node.gl will create a complete environment (based on Python venv module):

% make
[...]
    Install completed.

    You can now enter the venv with:
        . /home/user/node.gl/nodegl-env/bin/activate

Jobbed make calls are supported, so you can use make -jN where N is the number of parallel processes.

Note: to leave the environment, you can use deactivate.

Installation of libnodegl (the core library)

Build

make is enough to build libnodegl.a.

If you prefer a dynamic library, you can use the variable SHARED, such as make SHARED=yes.

If you need symbol debugging, you can use make DEBUG=yes.

Make allow options to be combinable, so make SHARED=yes DEBUG=yes is valid.

Additionally, PYTHON and PKG_CONFIG which respectively allows to customize python and pkg-config executable paths.

Installation

make install will install the library in PREFIX, which you can override, for example using make install PREFIX=/tmp/local.

You can check the installed version of libnodegl using pkg-config --modversion libnodegl

Installation of ngl-tools

The node.gl tools located in the ngl-tools/ directory are to be built and installed exactly the same way as libnodegl.

Installation of pynodegl (the Python binding)

pip install -r ./pynodegl/requirements.txt
pip install ./pynodegl

Installation of pynodegl-utils (the Python utilities and examples)

pip install -r ./pynodegl-utils/requirements.txt
pip install ./pynodegl-utils