|
1 | | -# How to Build |
| 1 | +#How to Build |
2 | 2 |
|
3 | 3 | For building and running the project, we recommend using [Visual Studio Code](https://code.visualstudio.com/) (VSCode) as your IDE, along with the C/C++ and CMake Tools extensions. These extensions significantly simplify the building process. However, you are free to use any IDE of your choice. If you are on a UNIX-like system, the `compile.sh` script can be used for compilation (see [using compile.sh](#using-compile.sh)). |
4 | 4 |
|
5 | 5 | ## CMake Options: |
6 | 6 |
|
7 | | -| CMake Option | Default value | Description | |
8 | | -| - | - | - | |
9 | | -| `RAYX_ENABLE_OPENMP:BOOL` | `ON` | enable search for OpenMP on your system. If found, build with OpenMP for tracing on CPU | |
10 | | -| `RAYX_REQUIRES_OPENMP:BOOL` | `OFF` | require OpenMP to be found on your system. Otherwise throw an error | |
11 | | -| `RAYX_ENABLE_CUDA:BOOL` | `ON` | enable search for Cuda on your system. If found, build with Cuda for tracing on GPU | |
12 | | -| `RAYX_REQUIRES_CUDA:BOOL` | `OFF` | require Cuda to be found on your system. Otherwise throw an error | |
13 | | -| `RAYX_ENABLE_H5:BOOL` | `ON` | enable search for HDF5 on your system. If found, build with HDF5 for H5 file format support | |
14 | | -| `RAYX_REQUIRES_H5:BOOL` | `OFF` | require HDF5 to be found on your system. Otherwise throw an error | |
15 | | -| `RAYX_STATIC_LIB:BOOL` | `OFF` | This option builds 'rayx-core' as a static library | |
| 7 | +| CMake Option | Default value | Description | |
| 8 | +| - | - | - | |
| 9 | +| `RAYX_ENABLE_OPENMP:BOOL` | `ON` | enable search for OpenMP on your system. If found, build with OpenMP for tracing on CPU | |
| 10 | +| `RAYX_REQUIRES_OPENMP:BOOL` | `OFF` | require OpenMP to be found on your system. Otherwise throw an error | |
| 11 | +| `RAYX_ENABLE_CUDA:BOOL` | `ON` | enable search for Cuda on your system. If found, build with Cuda for tracing on GPU | |
| 12 | +| `RAYX_REQUIRES_CUDA:BOOL` | `OFF` | require Cuda to be found on your system. Otherwise throw an error | |
| 13 | +| `RAYX_ENABLE_H5:BOOL` | `ON` | enable search for HDF5 on your system. If found, build with HDF5 for H5 file format support | |
| 14 | +| `RAYX_REQUIRES_H5:BOOL` | `OFF` | require HDF5 to be found on your system. Otherwise throw an error | |
| 15 | +| `RAYX_STATIC_LIB:BOOL` | `OFF` | this option builds 'rayx-core' as a static library | |
| 16 | +| `CMAKE_CUDA_ARCHITECTURES:STRING` | `all-major` | set the cuda device architectures to build for. by default, build for all major architectures | |
16 | 17 |
|
17 | 18 | ## Cloning the Repository |
18 | 19 |
|
|
0 commit comments