95 implement embree runner

.github/workflows/CI.yml

@@ -61,6 +61,43 @@ jobs:
         sudo apt-get update
         sudo apt-get install -y libfontconfig1-dev
 
+    - name: Install embree (Ubuntu)
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libembree-dev
+
+    - name: Install embree (macOS)
+      if: matrix.os == 'macOS-latest'
+      run: |
+        brew install embree
+
+    - name: Install embree (Windows)
+      if: matrix.os == 'windows-latest'
+      shell: pwsh
+      run: |
+        $embreeVersion = "4.4.0"
+        $embreeUrl = "https://github.com/embree/embree/releases/download/v$embreeVersion/embree-$embreeVersion.x64.windows.zip"
+        $embreeZip = "$env:TEMP\embree.zip"
+        $embreeDir = "C:\embree"
+
+        Write-Host "Downloading Embree $embreeVersion..."
+        Invoke-WebRequest -Uri $embreeUrl -OutFile $embreeZip
+
+        Write-Host "Extracting Embree..."
+        Expand-Archive -Path $embreeZip -DestinationPath $embreeDir -Force
+
+        # $embreeRoot = Get-ChildItem -Path $embreeDir -Directory -Filter "embree*" | Select-Object -First 1
+        $embreeCMake = Join-Path $embreeDir "lib\cmake\embree-$embreeVersion"
+        $embreeLib = Join-Path $embreeDir "bin"
+
+        # Write-Host "Embree root: $($embreeRoot.FullName)"
+        Write-Host "Embree CMake: $embreeCMake"
+        Write-Host "Embree Lib: $embreeLib"
+
+        echo "embree_DIR=$embreeCMake" >> $env:GITHUB_ENV
+        echo "$embreeLib" >> $env:GITHUB_PATH
+
     - name: Set reusable strings
       # Turn repeated input strings (such as the build output directory) into step outputs. These step outputs can be used throughout the workflow file.
       id: strings
@@ -77,6 +114,7 @@ jobs:
         -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
         -DSOLTRACE_BUILD_GUI=OFF
+        -DSOLTRACE_BUILD_EMBREE_SUPPORT=ON
         -S ${{ github.workspace }}
 
     - name: Build-Windows

.github/workflows/coverage.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y lcov libfontconfig1-dev
+        sudo apt-get install -y lcov libfontconfig1-dev libembree-dev
 
     - name: Set reusable strings
       id: strings
@@ -43,6 +43,7 @@ jobs:
         -DSOLTRACE_BUILD_CORETRACE=OFF
         -DSOLTRACE_BUILD_GUI=OFF
         -DENABLE_COVERAGE=ON
+        -DSOLTRACE_BUILD_EMBREE_SUPPORT=ON
         -S ${{ github.workspace }}
 
     - name: Build

CMakeLists.txt

@@ -6,8 +6,14 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
 
 option(SOLTRACE_BUILD_GUI "Build the GUI parts of Soltrace" OFF)
-option(SOLTRACE_BUILD_CORETRACE "Build the coretrace library (ray tracing core)" ON)
+option(
+	SOLTRACE_BUILD_CORETRACE 
+	"Legacy ray tracing backend including the strace executable"
+	OFF)
+
+option(SOLTRACE_BUILD_EMBREE_SUPPORT "Build Embree support for ray tracing" OFF)
 option(SOLTRACE_BUILD_OPTIX_SUPPORT "Build the OptiX support for ray tracing" OFF)
+
 option(SOLTRACE_BUILD_PERF_TEST "Build performance tests (not built for debug)" OFF)
 
 option(FULL_FIELD_VALIDATION_TEST "Include full field validation tests" OFF)

README.md

@@ -21,7 +21,7 @@ The `pysoltrace` API is capable of running multi-threaded simulations, generatin
 
 The API requires the compiled coretrace library. Project files for building this library are generated using CMake as outlined in the steps below. It is possible to build only coretrace and not build the graphical interface by following the steps 1-7, but only building the `coretrace_api` project in step 7.vii.
 
-## Steps for Building SolTrace
+## Steps for Building SolTrace (Legacy)
 
 These are the general steps you need to follow to set up your computer for developing SolTrace:
 
@@ -78,6 +78,62 @@ These are the general steps you need to follow to set up your computer for devel
 
         Note that output is NOT stored in the ```build-soltrace/``` directory!
 
+## Steps for Building SolTrace (work in progress)
+
+SolTrace has been updated to use multiple ray tracing engines in addition to the prior implementation. Currently, there is no graphical user interface (it is underdevelopment).
+
+Building SolTrace (develop branch) requires a C++-17 capable compiler and cmake 3.19 or greater.  Once these are available, building can be done in the normal pattern of configure and build:
+
+```sh
+git clone https://github.com/NatLabRockies/SolTrace.git
+cd SolTrace
+mkdir build
+cd build
+cmake ..
+cmake --build . -j4
+```
+
+Note the `-j4` instructs cmake to use 4 processes to compile the source code. This can be adjusted if the number of processors available is greater (or less) than 4.
+
+### Building with Intel's Embree Ray Tracing Library
+
+Information about Embree can be found on the [Embree webpage](https://www.embree.org/) or on the [Embree github page](https://github.com/RenderKit/embree).
+
+Prior to building SolTrace, you will need to install Embree v4.x.x. On Linux this is best done with a package manager. E.g.,
+
+```sh
+sudo apt-get update
+sudo apt-get install libembree-dev
+```
+On Mac, you can use Homebrew
+
+```sh
+brew install embree
+```
+
+On Windows (this works for Linux and MacOS as well), you need to download the binaries from the [github page](https://github.com/RenderKit/embree) (under the appropriate installation header). Follow the corresponding install instructions found there.
+
+Once Embree is installed, clone the SolTrace repo, configure with embree enabled, and build:
+
+```sh
+git clone https://github.com/NatLabRockies/SolTrace.git
+cd SolTrace
+mkdir build
+cd build
+cmake .. -DSOLTRACE_BUILD_EMBREE_SUPPORT=ON
+cmake --build . -j4
+```
+
+If cmake is having trouble locating the Embree install, you specify Embree's install location passing the `embree_DIR` variable to cmake. In this case the configure command would be
+
+```sh
+cmake .. -DSOLTRACE_BUILD_EMBREE_SUPPORT=ON -Dembree_DIR=<EMBREE_INSTALL_DIR>
+```
+
+### Building with Nvidia's Optix Ray Tracing Library
+
+TODO.
+
 ## Contributing
 
 If you would like to report an issue with SolTrace or make a feature request, please let us know by adding a new issue on the [issues page](https://github.com/NREL/SolTrace/issues).

coretrace/simulation_data/CMakeLists.txt

@@ -25,14 +25,14 @@ set(SIMDATA_SRC
     stage_element.cpp
     sun.cpp
     surface.cpp
-    virtual_element.cpp
+    utilities.cpp
     vector3d.cpp
+    virtual_element.cpp
     cst_templates/arclength.cpp
     cst_templates/heliostat.cpp
     cst_templates/linear_fresnel.cpp
     cst_templates/parabolic_dish.cpp
     cst_templates/parabolic_trough.cpp
-    cst_templates/utilities.cpp
     solar_position_calculators/solar_position_calculator.cpp
     solar_position_calculators/lib_irradproc.cpp
     solar_position_calculators/solpos.cpp
@@ -60,14 +60,14 @@ set(SIMDATA_HDRS
     stage_element.hpp
     sun.hpp
     surface.hpp
+    utilities.hpp
     vector3d.hpp
-    # virtual_element.hpp
+    virtual_element.hpp
     cst_templates/arclength.hpp
     cst_templates/heliostat.hpp
     cst_templates/linear_fresnel.hpp
     cst_templates/parabolic_dish.hpp
     cst_templates/parabolic_trough.hpp
-    cst_templates/utilities.hpp
     solar_position_calculators/solar_position_calculator.hpp
     solar_position_calculators/lib_irradproc.h
     solar_position_calculators/solpos00.h