Skip to content
Update Developer Installation authored by AbedYassine's avatar AbedYassine
......@@ -83,7 +83,7 @@
6. Configure PDT-SPACE with ``cmake`` by executing the following:
```
cmake \
> cmake \
-DARCH=${AVX_ARCH} \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_CXX_COMPILER=${OUT_CXX} \
......@@ -95,9 +95,9 @@
```
- Once CMake runs without errors, you will have project files for your chosen generator in the build directory.
- **Note**: The above ``cmake`` command assumes that all the required libraries other than FullMonteSW and Mosek are installed globally using ``sudo`` privilages. If that's not the case, please look at the _CMAKE Variables_ section below that summarizes the important variables you need to supply for ``cmake``.
- **Note**: The above ``cmake`` command defaults to the build tool ``make``. If you want to use ``ninja`` for instance, you need to add the following to the command:
- **Note**: The above ``cmake`` command defaults to the build tool ``make``. If you want to use ``ninja`` for instance, you need to start the command with:
```
cmake -G Ninja
> cmake -G Ninja
```
7. Build PDT-SPACE: From your build directory, invoke your build tool (``make``, ``ninja``, etc) and the software should be built.
```
......@@ -108,4 +108,21 @@
### Notes:
- If the build system *generates correctly* and *then* fails, please log an issue in our bug tracker ([this wiki page](Fixing-bugs-and-adding-features)). It's not a bug if prerequisites are not installed (unless they are undocumented), or if they are installed but not provided to CMake. Please include the command line you used to run `cmake` or `ccmake`, a copy of `CMakeCache.txt` from your build directory, and the error text. Thank you!
- If you wish to install the software for use, it will be installed in the `CMAKE_INSTALL_PREFIX` dir when you run `make install`. Note this may require `sudo` if installing in `/usr` or other global dirs.
## CMake Variables:
CMake variables can be specified on the command line in the form ``-D<var>=<value>``, eg. ``-DCMAKE_BUILD_TYPE=RELEASE``
Some useful/important variables are listed below:
|Variable |Values |Description |
|----------------------|----------------------------------------------|---------------------------------------------------------|
|CMAKE\_BUILD\_TYPE |Release, Debug, Debug\_check or RelWithDebInfo|Build type (Recommended: Release for highest performance)|
|Boost\_DIR |path |Directory prefix of Boost's ``include/boost`` and ``lib`` directories. May be omitted if they are in the standard location (eg. installed by package manager)|
|VTK\_DIR |path |The location of VTKConfig.cmake. May be omitted if installed globally. |
|MOSEK\_PREFIX |path |Directory prefix of Mosek's ``h`` and ``bin`` directories|
|FullMonteSW\_DIR |path |The location of FullMonteSWConfig.cmake |
|Eigen3\_DIR |path |The location of Eigen3Config.cmake |
|CMAKE\_INSTALL\_PREFIX |path |Location where files are installed when the ``install`` target is invoked |
|ARCH |AVX/AVX2 |Supported instruction architecture of the current machine |
# Next Steps
In order to verify your installation, please visit the [Running PDT-SPACE](Running-PDT-SPACE) tutorial.
\ No newline at end of file