1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
Building and Finding OSPRay
===========================
The latest OSPRay sources are always available at the [OSPRay GitHub
repository](http://github.com/ospray/ospray). The default `master`
branch should always point to the latest bugfix release.
Prerequisites
-------------
OSPRay currently supports Linux, Mac OS\ X, and Windows. In addition,
before you can build OSPRay you need the following prerequisites:
- You can clone the latest OSPRay sources via:
git clone https://github.com/ospray/ospray.git
- To build OSPRay you need [CMake](http://www.cmake.org), any form of
C++11 compiler (we recommend using GCC, but also support Clang,
MSVC, and [Intel® C++ Compiler
(icc)](https://software.intel.com/en-us/c-compilers)), and standard
Linux development tools.
- Additionally you require a copy of the [Intel® Implicit SPMD Program
Compiler (ISPC)](http://ispc.github.io), version 1.23.0 or later.
Please obtain a release of ISPC from the [ISPC downloads
page](https://ispc.github.io/downloads.html).
If ISPC is not found by CMake its location can be hinted with the
variable `ISPC_EXECUTABLE`.
- OSPRay builds on top of the [Intel Rendering Toolkit (Render Kit) common
library (rkcommon)](https://www.github.com/ospray/rkcommon). The
library provides abstractions for tasking, aligned memory
allocation, vector math types, among others. For users who also need
to build rkcommon, we recommend the default the Intel [Threading
Building Blocks (TBB)](https://www.threadingbuildingblocks.org/) as
tasking system for performance and flexibility reasons.
TBB must be built from source when targeting ARM CPUs, or can
be built from source as part of the [superbuild](#cmake-superbuild).
Alternatively you can set CMake variable `RKCOMMON_TASKING_SYSTEM`
to `OpenMP` or `Internal`.
- OSPRay also heavily uses Intel [Embree], installing version 4.3.3
or newer is required. If Embree is not found by CMake its location
can be hinted with the variable `embree_DIR`.
- OSPRay supports volume rendering (enabled by default via
`OSPRAY_ENABLE_VOLUMES`), which heavily uses Intel [Open VKL],
version 2.0.1 or newer is required.
If Open VKL is not found by CMake its location can be hinted with
the variable `openvkl_DIR`, or disable `OSPRAY_ENABLE_VOLUMES`.
- OSPRay also provides an optional module implementing the `denoiser`
image operation, which is enabled by `OSPRAY_MODULE_DENOISER`. This
module requires Intel [Open Image Denoise] in version 2.3.0 or
newer. You may need to hint the location of the library with the
CMake variable `OpenImageDenoise_DIR`.
- For the optional MPI modules (enabled by `OSPRAY_MODULE_MPI`), which
provide the `mpiOffload` and `mpiDistributed` devices, you need an
MPI library and [Google Snappy](https://github.com/google/snappy).
- The optional example application, the test suit and benchmarks need
some version of OpenGL and GLFW as well as
[GoogleTest](https://github.com/google/googletest) and [Google
Benchmark](https://github.com/google/benchmark/)
Depending on your Linux distribution you can install these dependencies
using `yum` or `apt-get`. Some of these packages might already be
installed or might have slightly different names.
Type the following to install the dependencies using `yum`:
sudo yum install cmake.x86_64
sudo yum install tbb.x86_64 tbb-devel.x86_64
Type the following to install the dependencies using `apt-get`:
sudo apt-get install cmake-curses-gui
sudo apt-get install libtbb-dev
Under Mac OS\ X these dependencies can be installed using
[MacPorts](http://www.macports.org/):
sudo port install cmake tbb
Under Windows please directly use the appropriate installers for
[CMake](https://cmake.org/download/),
[TBB](https://github.com/oneapi-src/oneTBB/releases),
[ISPC](https://ispc.github.io/downloads.html) (for your Visual Studio
version) and [Embree](https://github.com/embree/embree/releases/).
### Additional Prerequisites for GPU Build {-}
To build OSPRay's GPU module you need
- a SYCL compiler, either the open source [oneAPI DPC++ Compiler
2023-10-26](https://github.com/intel/llvm/releases/tag/nightly-2023-10-26)
or the latest [Intel oneAPI DPC++/C++
Compiler](https://www.intel.com/content/www/us/en/developer/articles/tool/oneapi-standalone-components.html#dpcpp-cpp)
- a recent [CMake](http://www.cmake.org), version 3.25.3 or higher
|
