This is a draft of the installation instructions with cmake. It will eventually replace https://igraph.org/c/#startc Feel free to edit as needed.
Note to interested readers: igraph is an open-source project. All development happens in the open. If you want to test the development version, you can check out the
develop branch and build it using the instructions below. Beware that changes happen quickly and regularly!
To build igraph from sources, you will need at least:
- CMake 3.16 or later
- C and C++ compilers
Certain features also require the following libraries:
igraph bundles a number of libraries for convenience. However, it is preferable to use external versions of these libraries, which may improve performance. These are:
- CXSparse from SuiteSparse
- A library providing a BLAS API (available by default on macOS; OpenBLAS is one option on other systems)
- A library providing a LAPACK API (available by default on macOS; OpenBLAS is one option on other systems)
When building the development version of igraph,
git are also required. Released versions do not require these tools.
To run the tests,
diff is also required.
General build instructions
igraph uses a CMake-based build system. To compile it,
- Enter the directory where the igraph sources are:
- Create a new directory. This is where igraph will be built:
mkdir build cd build
- Run cmake, which will automatically configure igraph, and report the configuration:
To set a non-default installation location, such as
cmake .. -DCMAKE_INSTALL_PREFIX=/opt/local
- Check the output carefully, and ensure that all features you need are enabled. If cmake could not find certain libraries, some features such as GraphML support may have been automatically disabled.
- There are several ways to adjust the configuration:
ccmake .on Unix-like systems or
cmake-guion Windows for a convenient interface.
- Simply edit the
CMakeCache.txtfile. Some of the relevant options are listed below.
- Once the configuration has been adjusted, run
- Once igraph has been successfully configured, it can be built, tested and installed using:
cmake --build . cmake --build . --target check cmake --install
Specific instructions for Windows
Microsoft Visual Studio
– TODO –
MSYS2 can be installed from www.msys2.org. After installing MSYS2, ensure that it is up to date by opening a terminal and running
The instructions below assume that you want to compile for a 64-bit target.
Install the following packages using
- Minimal requirements:
- Optional dependencies that enable certain features:
- Optional external libraries for better performance:
- Only needed for running the tests:
- Required only when building the development version:
The following command will install of these at once:
pacman -S \ mingw-w64-x86_64-toolchain mingw-w64-x86_64-cmake \ mingw-w64-x86_64-gmp mingw-w64-x86_64-libxml2 \ mingw-w64-x86_64-openblas mingw-w64-x86_64-suitesparse mingw-w64-x86_64-arpack mingw-w64-x86_64-glpk \ diffutils \ git bison flex
In order to build igraph, follow the General build instructions above, paying attention to the following:
- When using MSYS2, start the “MSYS2 MinGW 64-bit” terminal, and not the “MSYS2 MSYS” one.
- Be sure to install the
mingw-w64-x86_64-cmakepackage and not the
cmakeone. The latter will not work.
- When running
cmake, pass the option `-G"MSYS Makefiles".
- Note that
ccmakeis not currently available.
cmake-guican be used only if the
mingw-w64-x86_64-qt5package is installed.
Notable configuration options
The following options may be set to
OFF. Some of them have an
AUTO setting, which chooses a reasonable default based on what libraries are available on the current system.
igraph bundles some of its dependencies for convenience. The
IGRAPH_USE_INTERNAL_XXXflags control whether these should be used instead of external versions. Set them to
ONto use the bundled (“vendored”) versions. Generally, external versions are preferable as they may be newer and usually provide better performance.
IGRAPH_GLPK_SUPPORT: whether to make use of the GLPK library. Some features, such as finding a minimum feedback arc set or finding communities through exact modularity optimization, require this.
IGRAPH_ENABLE_LTO: whether to build igraph with link-time optimization, which improves performance. Not supported with all compilers.
IGRAPH_ENABLE_TLS: whether to enable thread-local storage. Required when using igraph from multiple threads.
BUILD_SHARED_LIBS: whether to build a shared library instead of a static one.
CMAKE_INSTALL_PREFIX: the location where igraph will be installed
Compiling programs that use igraph
If igraph was built as a static library on Windows, it is necessary to define
IGRAPH_STATIC when building programs that will link to igraph.