Skip to content

Latest commit

 

History

History
130 lines (98 loc) · 5.41 KB

INSTALL.md

File metadata and controls

130 lines (98 loc) · 5.41 KB
Raw

Building OSL

OSL currently compiles and runs cleanly on Linux (x86_64), Mac OS X (x86_64 and aarch64), and Windows (x86_64). It may build and run on other platforms as well, but we don't officially support or test other than these platforms.

Shader execution is supported on the native architectures of those x86_64 and aarch64 platforms, a special batched 4-, 8- or 16-wide SIMD execution mode requiring x86_64 with SSE2, AVX/AVX2 or AVX-512 instructions, as well as on NVIDIA GPUs using Cuda+OptiX.

Dependencies

OSL requires the following dependencies or tools. NEW or CHANGED dependencies since the last major release are bold.

  • Build system: CMake 3.15 or newer (tested through 3.30)

  • A suitable C++17 compiler to build OSL itself, which may be any of:

    • GCC 9.3 or newer (tested through gcc 12.1)
    • Clang 5 or newer (tested through clang 18)
    • Microsoft Visual Studio 2017 or newer
    • Intel C++ compiler icc version 19 or newer or LLVM-based icx compiler version 2022 or newer.

  • OpenImageIO 2.4 or newer (tested through 2.5 and main)

    OSL uses OIIO both for its texture mapping functionality as well as numerous utility classes. If you are integrating OSL into an existing renderer, you may use your own favorite texturing system rather than OpenImageIO with a little minor surgery. There are only a few places where OIIO texturing calls are made, and they could easily be bypassed. But it is probably not possible to remove OIIO completely as a dependency, since we so heavily rely on a number of other utility classes that it provides (for which there was no point reinventing redundantly for OSL).

    After building OpenImageIO, if you don't have it installed in a "standard" place (like /usr/include), you should set the environment variable $OpenImageIO_ROOT to point to the compiled distribution, and then OSL's build scripts will be able to find it. You should also have $OpenImageIO_ROOT/lib to be in your LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X).

  • LLVM 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, or 19, including clang libraries.

  • (optional) For GPU rendering on NVIDIA GPUs:

    • OptiX 7.0 or higher.
    • Cuda 9.0 or higher. It is recommended that you use 11.0 or higher.

  • Imath 3.1 or newer.

  • Flex 2.5.35 or newer and GNU Bison 2.7 or newer. Note that on some MacOS/xcode releases, the system-installed Bison is too old, and it's better to install a newer Bison (via Homebrew is one way to do this easily).

  • PugiXML >= 1.8 (we have tested through 1.13).

  • (optional) Partio If it is not found at build time, the OSL pointcloud functions will not be operative.

  • (optional) Python: If you are building the Python bindings or running the testsuite:

    • Python >= 3.7 (tested through 3.12)
    • pybind11 >= 2.7 (tested through 2.13)
    • NumPy

  • (optional) Qt5 >= 5.6 or Qt6 (tested Qt5 through 5.15 and Qt6 through 6.7). If not found at build time, the osltoy application will be disabled.

Build process

Here are the steps to check out, build, and test the OSL distribution:

  1. Install and build dependencies.

  2. Check out a copy of the source code from the Git repository:

     git clone https://github.com/AcademySoftwareFoundation/OpenShadingLanguage.git osl

  3. Change to the distribution directory and 'make'

     cd osl
 make

    Note: OSL uses 'CMake' for its cross-platform build system. But for simplicity, we have made a "make wrapper" around it, so that by just typing 'make' everything will build. Type 'make help' for other options, and note that 'make nuke' will blow everything away for the freshest possible compile.

    You can also ignore the top level Makefile wrapper, and instead use CMake directly:

    cmake -B build -S .
cmake --build build --target install

    NOTE: If the build breaks due to compiler warnings which have been elevated to errors, you can try "make clean" followed by "make STOP_ON_WARNING=0", or if using cmake directly, add -DSTOP_ON_WARNING=0 to the cmake configuration command. That will create a build that will only stop for full errors, not warnings.

  4. After compilation, you'll end up with a full OSL distribution in dist/

  5. Add the "dist/bin" to your $PATH, and "dist/lib" to your $LD_LIBRAY_PATH (or $DYLD_LIBRARY_PATH on MacOS), or copy the contents of those files to appropriate directories. Public include files (those needed when building applications that incorporate OSL) can be found in "dist/include", and documentation can be found in "dist/share/doc".

  6. After building (and setting your library path), you can run the test suite with:

     make test

Troubleshooting