Add note that it requires a compiler.

eriknw · Dec 17, 2023 · 7397eff · 7397eff
1 parent 424dd76
commit 7397eff
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/suitesparse_graphblas/__init__.py b/suitesparse_graphblas/__init__.py
@@ -83,7 +83,8 @@ def initialize(*, blocking=False, memory_manager="numpy", jit_config="python"):
         SuiteSparse:GraphBLAS was compiled. 'disable' completely turns off the JIT.
         If you are using a distributed binary of SuiteSparse:GraphBLAS, then you
         probably want to use 'python', otherwise you may want to use 'suitesparse'
-        if SuiteSparse:GraphBLAS was compiled locally. Default is 'python'.
+        if SuiteSparse:GraphBLAS was compiled locally. Using the
+        SuiteSparse:GraphBLAS JIT requires a C compiler. Default is 'python'.
 
     The global variable `suitesparse_graphblas.is_initialized` indicates whether
     GraphBLAS has been initialized.

diff --git a/suitesparse_graphblas/jit.py b/suitesparse_graphblas/jit.py
@@ -78,6 +78,8 @@ def _set_defaults_common(**override):
 def set_suitesparse_defaults():
     """Enable the JIT and set all JIT configs to the SuiteSparse:GraphBLAS defaults.
 
+    Using the SuiteSparse:GraphBLAS JIT requires a C compiler.
+
     This sets values for:
     - GxB_JIT_C_CONTROL
     - GxB_JIT_USE_CMAKE
@@ -100,6 +102,8 @@ def set_suitesparse_defaults():
 def set_python_defaults():
     """Enable the JIT and set configs with compiler configs from ``sysconfig`` module.
 
+    Using the SuiteSparse:GraphBLAS JIT requires a C compiler.
+
     This uses ``sysconfig`` to set the values for:
     - GxB_JIT_C_COMPILER_NAME
     - GxB_JIT_C_COMPILER_FLAGS