You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -50,33 +51,25 @@ with suitable arguments. The supported arguments are (run `python3 setup.py conf
50
51
51
52
This does not actually run CMake to configure the C++ build but merely performs some rudimentary checks and saves the parameters.
52
53
53
-
Note that specifying the compiler of build type when running `python3 setup.py build` does not work; they need to be set when configuring.
54
+
Note that specifying the compiler or build type when running `python3 setup.py build` does not work; they need to be set when configuring.
54
55
55
56
## Building
56
57
For **users**:
57
58
Compile and install the package using
58
59
```
59
-
pip3 install . [--user]
60
-
# or alternatively: python3 setup.py install [--user]
60
+
python3 setup.py build -j <number-of-threads>
61
+
python3 setup.py install [--user]
61
62
```
62
63
63
64
For **developers**:
64
65
Compile and install in development mode using
65
66
```
66
-
pip3 install -e . [--user]
67
-
# or alternatively: python3 setup.py develop [--user]
67
+
python3 setup.py develop [--user]
68
68
```
69
69
And just re-run the command after changing the code.
70
70
71
-
Unfortunately neither pip nor setup.py's install or develop commands support concurrent builds. So the first time you compile takes some time. If you installed in development mode, you can run
72
-
```
73
-
python3 setup.py build -j<n-threads>
74
-
```
75
-
to compile your changes in a parallel fashion.
76
-
However, if you are in development mode, you must compile using one of the above commands before you can use the explicit build command!
77
-
78
71
## Testing
79
-
Unit tests are automatically compiled when using the above commands (sorry for the extra compilation time, you are welcome to fix this :D).
72
+
Unit tests are automatically compiled when using the above commands (sorry for the extra compilation time, we are working on a way around that).
80
73
They only work however, if you are in development mode!
81
74
You can run them via
82
75
```
@@ -93,4 +86,4 @@ to generate the source code documentation using Doxygen. Then open `docs/html/in
93
86
94
87
Note that the `C++` interface is not identical to the `Python` interface. Documentation of the `Python` side is incomplete as of now.
95
88
96
-
There is additional documentation available under `docs/algorithm`; run `make` to generate it. This needs LaTeX to compiler PDFs.
89
+
There is additional documentation available under `docs/algorithm`; run `make` to generate it. This needs LaTeX to compile PDFs.
0 commit comments