Skip to content

Commit e91825d

Browse files
committed
Improve instructions on which clang compiler will be used in this example
1 parent e0b049a commit e91825d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Dirk Helbing introduced the social force model in a paper in 1995, aimed at mode
1717

1818
## Dependencies
1919

20-
- The [DPC++ compiler](https://intel.github.io/llvm-docs/GetStartedGuide.html) is required to compile SYCL code
20+
- The [DPC++ compiler](https://intel.github.io/llvm-docs/GetStartedGuide.html) is the required version of clang compiler to compile SYCL code
2121
- If targeting the DPC++ CUDA backend, the [CUDA runtime](https://intel.github.io/llvm-docs/GetStartedGuide.html#build-dpc-toolchain-with-support-for-nvidia-cuda) is required
2222
- If targeting the DPC++ OpenCL backend, an [OpenCL runtime](https://intel.github.io/llvm-docs/GetStartedGuide.html#install-low-level-runtime) is require
2323
- [CMake](https://cmake.org/install/) is used for build configuration
@@ -36,15 +36,15 @@ When enabled, the `-DPROFILING_MODE` option builds a headless version which can
3636

3737
When enabled, the `-DSTATS` option will collect metrics whilst the simulation is running. Results are written to `output/outputStats.txt`. Graphs can be produced from these metrics by running the python script [PlotGraphs.py](scripts/PlotGraphs.py).
3838

39-
By default, CMake should generate example input files by running [InputFileGenerator.py](scripts/InputFileGenerator.py) when generating the project makefiles.
39+
By default, CMake should generate example input files by running [InputFileGenerator.py](scripts/InputFileGenerator.py) when generating the project makefiles. Be sure to enter the path to the DPC++ clang compiler. This would normally reside in `/opt/intel/oneapi/latest/compiler/linux/bin-llvm/`. `latest` is an alias for the version of the oneAPI base toolkit installed.
4040

4141
The `crowdsim` executable takes an input configuration JSON as a command line argument.
4242

4343
```
4444
$ git clone https://github.com/codeplaysoftware/sycl-crowd-simulation.git
4545
$ cd crowd-simulation
4646
$ mkdir build && cd build
47-
$ cmake -DCMAKE_CXX_COMPILER=path/to/llvm/build/bin/clang++ -DSYCL_BACKEND=spir -DPROFILING_MODE=off -DSTATS=on ..
47+
$ cmake -DCMAKE_CXX_COMPILER=path/to/the/oneapi/llvm/build/bin/clang++ -DSYCL_BACKEND=spir -DPROFILING_MODE=off -DSTATS=on ..
4848
$ cmake --build .
4949
$ ./crowdsim ../input/evacuateRoom.json
5050
```

0 commit comments

Comments
 (0)