Rework CasADi libs detection (#61)

* Drop pybind11 submodule and update config

* Update installation docs in README

* Fix typo

* Also set `PYBIND11_FINDPYTHON`

* Oops, import from global dep

* Turn `FINDPYTHON` to `OFF`

* Set it back on, drop older `FindPython` mode

* Revert "Set it back on, drop older `FindPython` mode"

This reverts commit 37ebcd1.

* Add pybind11 include dir

* Pass pybind11's include dir

* Rework CasADi libs detection

* Lint

* Update CMakeLists.txt

Co-authored-by: Marc Berliner <[email protected]>

* Update CMakeLists.txt

Co-authored-by: Marc Berliner <[email protected]>

---------

Co-authored-by: Marc Berliner <[email protected]>

Author: agriyakhetarpal

CMakeLists.txt

@@ -2,10 +2,6 @@ cmake_minimum_required(VERSION 3.13)
 cmake_policy(SET CMP0074 NEW)
 set(CMAKE_VERBOSE_MAKEFILE ON)
 
-if (DEFINED Python_EXECUTABLE)
-    set(PYTHON_EXECUTABLE ${Python_EXECUTABLE})
-endif ()
-
 if (DEFINED ENV{VCPKG_ROOT_DIR} AND NOT DEFINED VCPKG_ROOT_DIR)
     set(VCPKG_ROOT_DIR "$ENV{VCPKG_ROOT_DIR}"
             CACHE STRING "Vcpkg root directory")
@@ -95,35 +91,73 @@ if (NOT DEFINED USE_PYTHON_CASADI)
     set(USE_PYTHON_CASADI TRUE)
 endif ()
 
+if (${USE_PYTHON_CASADI})
+    execute_process(
+            COMMAND "${PYTHON_EXECUTABLE}" -c
+            "import os; import sysconfig; print(os.path.join(sysconfig.get_path('purelib'), 'casadi', 'cmake'))"
+            OUTPUT_VARIABLE CASADI_DIR
+            OUTPUT_STRIP_TRAILING_WHITESPACE)
 
-execute_process(
-        COMMAND "${PYTHON_EXECUTABLE}" -c
-        "import os; import sysconfig; print(os.path.join(sysconfig.get_path('purelib'), 'casadi', 'cmake'))"
-        OUTPUT_VARIABLE CASADI_DIR
-        OUTPUT_STRIP_TRAILING_WHITESPACE)
-
-if (CASADI_DIR)
-    file(TO_CMAKE_PATH ${CASADI_DIR} CASADI_DIR)
-    message("Found Python casadi path: ${CASADI_DIR}")
-else ()
-    message(FATAL_ERROR "Did not find casadi path}")
-endif ()
+    if (CASADI_DIR)
+        file(TO_CMAKE_PATH ${CASADI_DIR} CASADI_DIR)
+        message("Found Python casadi path: ${CASADI_DIR}")
+    else ()
+        message(FATAL_ERROR "Did not find casadi path")
+    endif ()
 
-if (${USE_PYTHON_CASADI})
     message("Trying to link against Python casadi package in ${CASADI_DIR}")
-    find_package(casadi CONFIG PATHS ${CASADI_DIR} REQUIRED NO_DEFAULT_PATH)
+    if (EXISTS "${CASADI_DIR}/casadiConfig.cmake" OR EXISTS "${CASADI_DIR}/casadi-config.cmake")
+        find_package(casadi CONFIG PATHS ${CASADI_DIR} NO_DEFAULT_PATH)
+    else ()
+        message(WARNING "CasADi CMake config not found in ${CASADI_DIR}. Proceeding without find_package; using include and library paths discovered from the Python package.")
+    endif ()
+
+    execute_process(
+            COMMAND "${PYTHON_EXECUTABLE}" -c
+            "import casadi; from pathlib import Path; print(Path(casadi.__file__).parent / 'include')"
+            OUTPUT_VARIABLE CASADI_INCLUDE_DIR
+            OUTPUT_STRIP_TRAILING_WHITESPACE)
+
+    if (CASADI_INCLUDE_DIR)
+        file(TO_CMAKE_PATH ${CASADI_INCLUDE_DIR} CASADI_INCLUDE_DIR)
+        message("Found Python CasADi include directory: ${CASADI_INCLUDE_DIR}")
+        target_include_directories(idaklu PRIVATE ${CASADI_INCLUDE_DIR})
+    else ()
+        message(FATAL_ERROR "Could not find CasADi include directory")
+    endif ()
+
+    execute_process(
+            COMMAND "${PYTHON_EXECUTABLE}" -c
+            "import casadi; from pathlib import Path; import glob; lib_dir = Path(casadi.__file__).parent; lib_files = list(lib_dir.glob('*casadi*')); print(str(lib_dir) if lib_files else '')"
+            OUTPUT_VARIABLE CASADI_LIB_DIR
+            OUTPUT_STRIP_TRAILING_WHITESPACE)
+
+    if (CASADI_LIB_DIR)
+        file(TO_CMAKE_PATH ${CASADI_LIB_DIR} CASADI_LIB_DIR)
+        message("Found Python CasADi library directory: ${CASADI_LIB_DIR}")
+        target_link_directories(idaklu PRIVATE ${CASADI_LIB_DIR})
+
+        set_target_properties(
+                idaklu PROPERTIES
+                INSTALL_RPATH "${CASADI_LIB_DIR}"
+                INSTALL_RPATH_USE_LINK_PATH TRUE
+        )
+        # Attempt to link the casadi library directly if found
+        find_library(CASADI_LIBRARY NAMES casadi PATHS ${CASADI_LIB_DIR} NO_DEFAULT_PATH)
+        if (CASADI_LIBRARY)
+            message("Found CasADi library: ${CASADI_LIBRARY}")
+            target_link_libraries(idaklu PRIVATE ${CASADI_LIBRARY})
+        else ()
+            message(WARNING "CasADi library not found in ${CASADI_LIB_DIR}. The target will rely on transitive linkage via CMake config if available.")
+        endif ()
+    else ()
+        message(FATAL_ERROR "Could not find CasADi library directory")
+    endif ()
 else ()
     message("Trying to link against any casadi package apart from the Python one")
-    set(CMAKE_IGNORE_PATH "${CASADI_DIR}/cmake")
     find_package(casadi CONFIG REQUIRED)
 endif ()
 
-set_target_properties(
-        idaklu PROPERTIES
-        INSTALL_RPATH "${CASADI_DIR}"
-        INSTALL_RPATH_USE_LINK_PATH TRUE
-)
-
 # openmp
 if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
     execute_process(

README.md

@@ -42,7 +42,7 @@ pip install .
 Linux installs may vary based on the distribution, however, the basic build can
 be performed with the following commands:
 ```bash
-sudo apt-get install libopenblas-dev gcc make g++ build-essential
+sudo apt-get install libopenblas-dev gcc gfortran make g++ build-essential
 git submodules update --init --recursive
 pip install cmake casadi setuptools wheel "pybind11[global]"
 python install_KLU_Sundials.py

SuiteSparse

@@ -16,6 +16,10 @@
     "" if system() == "Windows" else str(Path(__file__).parent.resolve() / ".idaklu")
 )
 
+INCLUDE_DIRS = [str(Path(default_lib_dir) / "include"), pybind11.get_include()]
+
+USE_PYTHON_CASADI = False if system() == "Windows" else True
+
 # ---------- set environment variables for vcpkg on Windows ----------------------------
 
 
@@ -33,6 +37,23 @@ def set_vcpkg_environment_variables():
     )
 
 
+# ---------- find Python CasADi's include dirs (for Linux and macOS) -------------------
+
+
+def get_casadi_python_include_dir():
+    import casadi
+
+    casadi_path = Path(casadi.__file__).parent
+    include_dir = casadi_path / "include"
+    assert include_dir.exists(), f"CasADi include directory not found at {include_dir}"
+    return str(include_dir)
+
+
+if USE_PYTHON_CASADI:
+    casadi_include = get_casadi_python_include_dir()
+    INCLUDE_DIRS.append(casadi_include)
+    print(f"Adding CasADi include directory: {casadi_include}")
+
 # ---------- CMakeBuild class (custom build_ext for IDAKLU target) ---------------------
 
 
@@ -86,11 +107,6 @@ def run(self):
         # Build in parallel wherever possible
         os.environ["CMAKE_BUILD_PARALLEL_LEVEL"] = str(cpu_count())
 
-        if system() == "Windows":
-            use_python_casadi = False
-        else:
-            use_python_casadi = True
-
         build_type = os.getenv("PYBAMM_CPP_BUILD_TYPE", "Release")
         idaklu_expr_casadi = os.getenv("PYBAMM_IDAKLU_EXPR_CASADI", "ON")
 
@@ -99,7 +115,7 @@ def run(self):
         cmake_args = [
             f"-DCMAKE_BUILD_TYPE={build_type}",
             f"-DPYTHON_EXECUTABLE={sys.executable}",
-            "-DUSE_PYTHON_CASADI={}".format("TRUE" if use_python_casadi else "FALSE"),
+            "-DUSE_PYTHON_CASADI={}".format("TRUE" if USE_PYTHON_CASADI else "FALSE"),
             f"-DPYBAMM_IDAKLU_EXPR_CASADI={idaklu_expr_casadi}",
             f"-Dpybind11_DIR={pybind11_cmake_dir}",
         ]
@@ -110,6 +126,11 @@ def run(self):
         if self.sundials_root:
             cmake_args.append(f"-DSUNDIALS_ROOT={os.path.abspath(self.sundials_root)}")
 
+        if USE_PYTHON_CASADI:
+            casadi_include = get_casadi_python_include_dir()
+            cmake_args.append(f"-DCASADI_INCLUDE_DIR={casadi_include}")
+            print(f"Adding CasADi include directory to CMake: {casadi_include}")
+
         build_dir = self.get_build_directory()
         if not os.path.exists(build_dir):
             os.makedirs(build_dir)
@@ -272,7 +293,7 @@ def run(self):
             "src/pybammsolvers/idaklu_source/Options.cpp",
             "src/pybammsolvers/idaklu.cpp",
         ],
-        include_dirs=[str(Path(default_lib_dir) / "include"), pybind11.get_include()],
+        include_dirs=INCLUDE_DIRS,
     )
 ]