Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 2.73 KB

README.md

File metadata and controls

81 lines (53 loc) · 2.73 KB
Raw

dynamic-graph-python

Building Status Pipeline status Coverage report Code style: black pre-commit.ci status

Python bindings for dynamic-graph.

Warning: this repository contains [Git submodules][git-submodules]. Please clone this repository using the git clone --recursive command. If you already have cloned the repository, you can run git submodule init && git submodule update to retrieve the submodules.

Documentation

Online

Getting Help

Support is provided through:

How can I install dynamic-graph?

Compiling and installing the package

The manual compilation requires two steps:

  1. configuration of the build and generation of the build files
  2. compilation of the sources and installation of the package

dynamic-graph uses CMake to generate build files. It is recommended to create a separate build directory:

mkdir build
cd build
cmake ..
make
make test
make install

Options

Additional options can be set on the command line through the following command: -D<option>=<value>.

For instance: cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo .. will set the CMAKE_BUILD_TYPE option to the value RelWithDebInfo.

Available options are:

  • CMAKE_BUILD_TYPE set the build profile that should be used (debug, release, etc.). We recommend RelWithDebInfo as it will provide performances while keeping debugging symbols enabled.
  • CMAKE_INSTALL_PREFIX set the installation prefix (the directory where the software will be copied to after it has been compiled).

Running the test suite

The test suite can be run from your build directory by running:

make test

Please open a ticket if some tests are failing on your computer, it should not be the case.