- enabled header embedding for editable installs

- added new embedding option to updated README

Author: Felix Igelbrink

README.md

@@ -2,37 +2,58 @@
 
 Python wrapper for the OptiX 7 raytracing engine.
 
-Python-OptiX wraps the OptiX C++ API using Cython and provides a simplified 
-interface to the original C-like API using the 
-[CuPy](https://cupy.dev) package.
+Python-OptiX wraps the original OptiX C-like API using Cython while aiming to provide a more
+pythonic, object-oriented interface using the [CuPy](https://cupy.dev) package.
 
 ### Supported Platforms
 
 Only Linux is officially supported at the moment. Experimental windows support is available.
 
 ### OptiX Versions
 
-Python-OptiX currently supports the OptiX releases 7.3.0, 7.4.0 and 7.5.0
+Python-OptiX always supports the most recent version of the OptiX SDK. 
+The current version therefore supports OptiX 7.6.0
 
 ## Installation
 
 ### Dependencies
 
 Install a recent version of the [CUDA Toolkit](https://developer.nvidia.com/cuda-downloads)
-and the [OptiX 7.5.0 SDK](https://developer.nvidia.com/optix/downloads/7.5.0/linux64-x86_64)
+and the [OptiX 7.6.0 SDK](https://developer.nvidia.com/optix/downloads/7.6.0/linux64-x86_64)
 
-Make sure the CUDA header files are installed as well.
+Make sure the CUDA header files are installed as well. 
 
-Add the locations of CUDA and OptiX to the system `PATH` variable if necessary.
+Note, that for some variants of the CUDA Toolkit, 
+like the one installed by the `conda` package manager, these are not installed by default. 
+`conda`-environments require the additional `cudatoolkit-dev` package.
+
+### Environment
+
+`python-optix` requires both the OptiX as well as the CUDA include path during setup as well as runtime 
+to compile the CUDA kernels. Therefore, it is necessary to either add both locations to the system `PATH`
+or set the `CUDA_PATH` and `OPTIX_PATH` variables to the respective locations.
+
+The setup additionally has the option to embed the OptiX header files into the `python-optix` installation. 
+If the variable `OPTIX_EMBED_HEADERS` is set to `1`, the setup will copy the headers from the 
+OptiX SDK directory into the generated wheel.
+
+If this option was chosen during setup, setting the `OPTIX_PATH` is no longer required as the 
+embedded headers will be utilized then.
 
 ### Using pip
 ```
-pip install python-optix
+export OPTIX_PATH=/path/to/optix
+export CUDA_PATH=/path/to/cuda_toolkit
+export OPTIX_EMBED_HEADERS=1 # embed the optix headers into the package
+python -m pip install python-optix
 ```
 
 ### From source
 ```
 git clone https://github.com/mortacious/python-optix.git
 cd python-optix
-python setup.py install
+export OPTIX_PATH=/path/to/optix
+export CUDA_PATH=/path/to/cuda_toolkit
+export OPTIX_EMBED_HEADERS=1 # embed the optix headers into the package
+python -m pip install [-e] .
 ```

setup.py

@@ -30,14 +30,16 @@ def import_module_from_path(path):
 
 
 util = import_module_from_path('optix/path_utility.py')
-cuda_include_path = util.get_cuda_include_path()
-optix_include_path = util.get_optix_include_path()
+cuda_include_path = util.get_cuda_include_path(environment_variable='CUDA_PATH')
+optix_include_path = util.get_optix_include_path(environement_variable='OPTIX_PATH')
 print("Found cuda includes at", cuda_include_path)
 print("Found optix includes at", optix_include_path)
 if cuda_include_path is None:
-    raise RuntimeError("CUDA not found in the system, but is required to build this package.")
+    raise RuntimeError("CUDA not found in the system, but is required to build this package. Consider setting"
+                       "CUDA_PATH to the location of the local cuda toolkit installation.")
 if optix_include_path is None:
-    raise RuntimeError("OptiX not found in the system, but is required to build this package.")
+    raise RuntimeError("OptiX not found in the system, but is required to build this package. Consider setting "
+                       "OPTIX_PATH to the location of the optix SDK.")
 
 optix_version_re = re.compile(r'.*OPTIX_VERSION +(\d{5})')  # get the optix version from the header
 with open(Path(optix_include_path) / "optix.h", 'r') as f:
@@ -83,7 +85,7 @@ def glob_fix(package_name, glob):
             for path in package_path.glob(glob)]
 
 from setuptools.command.install import install as _install
-
+from setuptools.command.develop import develop as _develop
 
 class EmbeddHeadersCommandMixin:
     def update_package_data(self):
@@ -94,7 +96,7 @@ def update_package_data(self):
               self.distribution.package_data)
 
     def run(self):
-        embedd = os.getenv("OPTIX_ADD_HEADERS")
+        embedd = os.getenv("OPTIX_EMBED_HEADERS")
         if embedd:
             # create the path for the internal headers
             # due to optix license restrictions those headers
@@ -106,15 +108,19 @@ def run(self):
 
             self.update_package_data()
 
-
         super().run()
 
 
 class CustomInstallCommand(EmbeddHeadersCommandMixin, _install):
     pass
 
 
-cmd_classes = {'install': CustomInstallCommand}
+class CustomDevelopCommand(EmbeddHeadersCommandMixin, _develop):
+    pass
+
+
+cmd_classes = {'install': CustomInstallCommand,
+               'develop': CustomDevelopCommand}
 
 try:
     from wheel.bdist_wheel import bdist_wheel as _bdist_wheel