README.md 2.43 KB
Newer Older
1
# dynamic-graph-python
2

Guilhem Saurel's avatar
Guilhem Saurel committed
3
[![Building Status](https://travis-ci.org/stack-of-tasks/dynamic-graph-python.svg?branch=master)](https://travis-ci.org/stack-of-tasks/dynamic-graph-python)
Guilhem Saurel's avatar
Guilhem Saurel committed
4
5
[![Pipeline status](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/badges/master/pipeline.svg)](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/commits/master)
[![Coverage report](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/badges/master/coverage.svg?job=doc-coverage)](http://projects.laas.fr/stack-of-tasks/doc/stack-of-tasks/dynamic-graph-python/master/coverage/)
6

Francois Keith's avatar
Francois Keith committed
7
8
9
10
11
12
13
14
15
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.

16
## Documentation
Francois Keith's avatar
Francois Keith committed
17

18
[Online](https://gepettoweb.laas.fr/doc/stack-of-tasks/dynamic-graph-python/master/doxygen-html/)
Francois Keith's avatar
Francois Keith committed
19
20


21
## Getting Help
Francois Keith's avatar
Francois Keith committed
22
23

Support is provided through:
24
25
 * the [issue tracker](https://github.com/stack-of-tasks/dynamic-graph-python/issues)
 * the matrix room [#stack-of-tasks:laas.fr](https://matrix.to/#/#stack-of-tasks:laas.fr)
Francois Keith's avatar
Francois Keith committed
26
27


28
## How can I install dynamic-graph?
Francois Keith's avatar
Francois Keith committed
29
30
31
32
33
34
35
36

### 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

37
dynamic-graph uses CMake to generate build files. It is
Francois Keith's avatar
Francois Keith committed
38
39
40
recommended to create a separate build directory:

```sh
41
42
43
mkdir build
cd build
cmake ..
Francois Keith's avatar
Francois Keith committed
44
45
46
```

```sh
47
48
49
make
make test
make install
Francois Keith's avatar
Francois Keith committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
```

### 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:

```sh
75
make test
Francois Keith's avatar
Francois Keith committed
76
77
78
79
```

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