Building Regina from Source

Tip: See the page on building Regina on different systems, which offers advice tailored for your particular type of machine.

Regina's build scripts should detect most aspects of your system configuration, and give you useful error messages if something looks out of place. If Regina does not build out of the box for you, please mail the authors (including your CMakeCache.txt if possible) so that we can update the scripts to work with systems like yours in the next release.

In summary, to build Regina:

That's all there is to it. If you are having trouble building or running Regina, please check out the troubleshooting page and/or mail the authors for assistance.

System Requirements

The following table lists the tools and libraries that you will need to build Regina.

It is highly recommended that you download ready-made packages of these tools and libraries. This is the best way to provide standard installations in standard locations that Regina can easily find and use. All of these tools and libraries are included in almost every major GNU/Linux distribution.

The following table lists each requirement, along with its Debian package name and some commonly-used RPM package names (these tend to vary between different RPM-based distributions).

Legend
Required Optional

ComponentRequired For VersionPackage Names
C++ compiler Build infrastructure Must support C++11 g++ (DEB)
gcc-c++ (RPM)
CMake Build infrastructure ≥ 2.8.11 cmake (DEB)
cmake (RPM)
pkg-config Build infrastructure   pkg-config (DEB)
pkg-config / pkgconfig (RPM)
GNU multiprecision arithmetic library,
including libgmp and libgmpxx
Calculation engine   libgmp-dev (DEB)
gmp-devel (plus gmpxx-devel on some systems) (RPM)
GNOME XML library (libxml2) Calculation engine ≥ 2.5.0 libxml2-dev (DEB)
libxml2-devel (RPM)
Jansson JSON library (libjansson) Calculation engine   libjansson-dev (DEB)
jansson-devel / libjansson-devel (RPM)
Tokyo Cabinet library (libtokyocabinet) Calculation engine   libtokyocabinet-dev (DEB)
tokyocabinet-devel / libtokyocabinet-devel (RPM)
Popt command-line parsing library (libpopt) Command-line utilities   libpopt-dev (DEB)
popt-devel (RPM)
Boost libraries, including
libboost_iostreams and libboost_python
Multiple components ≥ 1.55 libboost-iostreams-dev & libboost-python-dev (DEB)
boost-devel (RPM)
Qt 5 libraries, including the Widgets and Svg modules Graphical user interface ≥ 5.4 qtbase5-dev & libqt5svg5-dev (DEB)
libqt5-qtbase-devel & libqt5-qtsvg-devel, or
qt5-qtbase-devel & qt5-qtsvg-devel, or
qtbase5-devel & qtsvg5-devel (RPM)
Python development libraries Python scripting 2.x python-dev (DEB)
python-devel (RPM)
Doxygen C++/Python API docs   doxygen (DEB)
doxygen (RPM)
Graphviz libraries Drawing graphs libgraphviz-dev (DEB)
graphviz-devel / libgraphviz-devel (RPM)
xsltproc User handbook   xsltproc (DEB)
libxslt / libxslt1 / xsltproc (RPM)
MPI development environment (e.g., Open MPI) MPI-enabled utilities   mpi-default-dev & mpi-default-bin (DEB)
(openmpi-devel / libopenmpi-devel) & openmpi (RPM)
CppUnit Test suite ≥ 1.8.0 libcppunit-dev (DEB)
cppunit-devel / libcppunit-devel (RPM)

Back to main page ... Back to main page ...