Skip to content

Latest commit

 

History

History
116 lines (70 loc) · 3.88 KB

README.md

File metadata and controls

116 lines (70 loc) · 3.88 KB
Raw

ViennaRay

🧪 Tests

ViennaRay is a flux calculation library for topography simulations, based in Intel®'s ray tracing kernel Embree. It is designed to provide efficient and high-performance ray tracing, while maintaining a simple and easy to use interface. ViennaRay was developed and optimized for use in conjunction with ViennaLS, which provides the necessary geometry representation. It is however possible to use this as a standalone library, with self-designed geometries.

Note

ViennaRay is under heavy development and improved daily. If you do have suggestions or find bugs, please let us know!

Support

Examples can be found on Github. Bug reports and suggestions should be filed on GitHub.

Releases

Releases are tagged on the main branch and available in the releases section.

Building

Supported Operating Systems

  • Windows (Visual Studio)

  • Linux (g++ / clang)

  • macOS (XCode)

System Requirements

  • C++17 Compiler with OpenMP support

Dependencies (installed automatically)

Since Embree is optimized for CPU's using SSE, AVX, AVX2, and AVX-512 instructions, it requires at least a x86 CPU with support for SSE2 or an Apple M1 CPU.

Installing

Since this is a header only project, it does not require any installation. However, we recommend the following procedure in order to set up all dependencies correctly:

git clone https://github.com/ViennaTools/ViennaRay.git
cd ViennaRay

cmake -B build -DCMAKE_INSTALL_PREFIX=/path/to/your/custom/install/
cmake --build build
cmake --install build

This will install the necessary headers and CMake files to the specified path. If -DCMAKE_INSTALL_PREFIX is not specified, it will be installed to the standard path for your system, usually /usr/local/.

Integration in CMake projects

We recommend using CPM.cmake to consume this library.

  • Installation with CPM

    CPMAddPackage("gh:viennatools/viennaray@3.1.0")

  • With a local installation

    In case you have ViennaRay installed in a custom directory, make sure to properly specify the CMAKE_PREFIX_PATH.

    list(APPEND CMAKE_PREFIX_PATH "/your/local/installation")

find_package(ViennaRay)
target_link_libraries(${PROJECT_NAME} PUBLIC ViennaTools::ViennaRay)

Building examples

The examples can be built using CMake:

cmake -B build -DVIENNARAY_BUILD_EXAMPLES=ON
cmake --build build

Running the Tests

ViennaRay uses CTest to run its tests. In order to check whether ViennaRay runs without issues on your system, you can run:

git clone https://github.com/ViennaTools/ViennaRay.git
cd ViennaRay

cmake -B build -DVIENNARAY_BUILD_TESTS=ON
cmake --build build
ctest --test-dir build

Contributing

If you want to contribute to ViennaRay, make sure to follow the LLVM Coding guidelines. Before creating a pull request, make sure ALL files have been formatted by clang-format, which can be done using the format-project.sh script in the root directory.

Authors

Current contributors: Tobias Reiter

Contact us via: viennatools@iue.tuwien.ac.at

ViennaRay was developed under the aegis of the 'Institute for Microelectronics' at the 'TU Wien'. http://www.iue.tuwien.ac.at/

License

See LICENSE file in the base directory.