rename flag to DISABLE_OPENCL

Author: JLBegin

pytissueoptics/rayscattering/__init__.py

@@ -15,7 +15,7 @@
 )
 from .energyLogging import EnergyLogger
 from .materials import ScatteringMaterial
-from .opencl import CONFIG, forceCalculationOnCPU, hardwareAccelerationIsAvailable
+from .opencl import CONFIG, disableOpenCL, hardwareAccelerationIsAvailable
 from .photon import Photon
 from .scatteringScene import ScatteringScene
 from .source import DirectionalSource, DivergentSource, IsotropicPointSource, PencilPointSource
@@ -49,6 +49,7 @@
     "View2DSliceZ",
     "samples",
     "Stats",
+    "disableOpenCL",
     "hardwareAccelerationIsAvailable",
     "CONFIG",
 ]

pytissueoptics/rayscattering/opencl/__init__.py

@@ -3,7 +3,7 @@
 import os
 
 OPENCL_OK = True
-PYTISSUE_FORCE_CPU = os.environ.get('PYTISSUE_FORCE_CPU', '0')
+OPENCL_DISABLED = os.environ.get("PTO_DISABLE_OPENCL", "0") == "1"
 
 if OPENCL_AVAILABLE:
     try:
@@ -15,15 +15,17 @@
 else:
     CONFIG = None
 
-def forceCalculationOnCPU():
-    os.environ["PYTISSUE_FORCE_CPU"] = "1"
-    print("You can define PYTISSUE_FORCE_CPU=1 in your profile to avoid this call.")
+
+def disableOpenCL():
+    os.environ["PTO_DISABLE_OPENCL"] = "1"
+    print("You can define PTO_DISABLE_OPENCL=1 in your profile to avoid this call.")
+
 
 def validateOpenCL() -> bool:
     notAvailableMessage = "Error: Hardware acceleration not available. Falling back to CPU. "
-    
-    if os.environ.get("PYTISSUE_FORCE_CPU", '0') != '0':
-        warnings.warn("User requested not using OpenCL with environment variable 'PYTISSUE_FORCE_CPU'=1.")
+
+    if os.environ.get("PTO_DISABLE_OPENCL", "0") == "1":
+        warnings.warn("User requested not to use OpenCL with environment variable 'PTO_DISABLE_OPENCL'=1.")
         return False
     if not OPENCL_AVAILABLE:
         warnings.warn(notAvailableMessage + "Please install pyopencl.")
@@ -37,7 +39,7 @@ def validateOpenCL() -> bool:
 
 
 def hardwareAccelerationIsAvailable() -> bool:
-    return OPENCL_AVAILABLE and OPENCL_OK and not PYTISSUE_FORCE_CPU
+    return OPENCL_AVAILABLE and OPENCL_OK and not OPENCL_DISABLED
 
 
 __all__ = ["IPPTable", "WEIGHT_THRESHOLD"]