i3558 improve wheel repair + add minimal IDAKLU test for built wheels

.github/workflows/publish_pypi.yml

@@ -16,9 +16,20 @@ on:
         required: false
         default: false
 
+# Set options available for all jobs that use cibuildwheel
+env:
+  # Increase pip debugging output, equivalent to `pip -vv`
+  CIBW_BUILD_VERBOSITY: 2
+  # Disable build isolation to allow pre-installing build-time dependencies.
+  # Note: CIBW_BEFORE_BUILD must be present in all jobs using cibuildwheel.
+  CIBW_BUILD_FRONTEND: "pip; args: --no-build-isolation"
+  # Skip PyPy and MUSL builds in any and all jobs
+  CIBW_SKIP: "pp* *musllinux*"
+  FORCE_COLOR: 3
+
 jobs:
   build_windows_wheels:
-    name: Build wheels on windows-latest
+    name: Wheels (windows-latest)
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
@@ -55,6 +66,8 @@ jobs:
         env:
           CIBW_ENVIRONMENT: 'PYBAMM_USE_VCPKG=ON VCPKG_ROOT_DIR=C:\vcpkg VCPKG_DEFAULT_TRIPLET=x64-windows-static-md VCPKG_FEATURE_FLAGS=manifests,registries CMAKE_GENERATOR="Visual Studio 17 2022" CMAKE_GENERATOR_PLATFORM=x64'
           CIBW_ARCHS: "AMD64"
+          CIBW_BEFORE_BUILD: python -m pip install setuptools wheel # skip CasADi and CMake
+          CIBW_TEST_COMMAND: python -c "import pybamm; pybamm.IDAKLUSolver()"
 
       - name: Upload Windows wheels
         uses: actions/upload-artifact@v3
@@ -63,16 +76,19 @@ jobs:
           path: ./wheelhouse/*.whl
           if-no-files-found: error
 
-  build_wheels:
-    name: Build wheels on ${{ matrix.os }}
+  build_macos_and_linux_wheels:
+    name: Wheels (${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
     steps:
       - uses: actions/checkout@v4
+        name: Check out PyBaMM repository
+
       - uses: actions/setup-python@v4
+        name: Set up Python
         with:
           python-version: 3.8
 
@@ -88,31 +104,32 @@ jobs:
           python -m pip install cmake wget
           python scripts/install_KLU_Sundials.py
 
-      - name: Build wheels on ${{ matrix.os }}
+      - name: Build wheels on Linux
         run: pipx run cibuildwheel --output-dir wheelhouse
+        if: matrix.os == 'ubuntu-latest'
         env:
           CIBW_ARCHS_LINUX: x86_64
           CIBW_BEFORE_ALL_LINUX: >
             yum -y install openblas-devel lapack-devel &&
             bash scripts/install_sundials.sh 6.0.3 6.5.0
-          CIBW_BEFORE_BUILD_LINUX: >
-            python -m pip install cmake casadi numpy
-          # override; point to casadi install path so that it can be found by the repair command
-          CIBW_REPAIR_WHEEL_COMMAND_LINUX: >
-            LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:$(python -c 'import casadi; print(casadi.__path__[0])')" auditwheel repair -w {dest_dir} {wheel}
+          CIBW_BEFORE_BUILD_LINUX: python -m pip install cmake casadi setuptools wheel
+          CIBW_REPAIR_WHEEL_COMMAND_LINUX: auditwheel repair -w {dest_dir} {wheel}
+          CIBW_TEST_COMMAND: python -c "import pybamm; print(pybamm.have_idaklu())" | grep True
+
+      - name: Build wheels on macOS
+        if: matrix.os == 'macos-latest'
+        run: pipx run cibuildwheel --output-dir wheelhouse
+        env:
           CIBW_BEFORE_BUILD_MACOS: >
-            python -m pip
-            install cmake casadi numpy &&
-            python scripts/fix_casadi_rpath_mac.py && scripts/fix_suitesparse_rpath_mac.sh
-          CIBW_REPAIR_WHEEL_COMMAND_MACOS: >
-            delocate-listdeps {wheel} &&
-            delocate-wheel -v -w {dest_dir} {wheel}
-          CIBW_SKIP: "pp* *musllinux*"
+            python -m pip install --upgrade cmake casadi setuptools wheel &&
+            scripts/fix_suitesparse_rpath_mac.sh
+          CIBW_REPAIR_WHEEL_COMMAND_MACOS: delocate-listdeps {wheel} && delocate-wheel -v -w {dest_dir} {wheel}
+          CIBW_TEST_COMMAND: python -c "import pybamm; print(pybamm.have_idaklu())" | grep True
 
       - name: Upload wheels
         uses: actions/upload-artifact@v3
         with:
-          name: wheels
+          name: macos_linux_wheels
           path: ./wheelhouse/*.whl
           if-no-files-found: error
 
@@ -126,9 +143,6 @@ jobs:
         with:
           python-version: 3.11
 
-      - name: Install dependencies
-        run: pip install --upgrade pip setuptools wheel
-
       - name: Build SDist
         run: pipx run build --sdist
 
@@ -140,9 +154,10 @@ jobs:
           if-no-files-found: error
 
   publish_pypi:
-    if: github.event_name != 'schedule'
+    # This job is only of value to PyBaMM and would always be skipped in forks
+    if: github.event_name != 'schedule' && github.repository == 'pybamm-team/PyBaMM'
     name: Upload package to PyPI
-    needs: [build_wheels, build_windows_wheels, build_sdist]
+    needs: [build_macos_and_linux_wheels, build_windows_wheels, build_sdist]
     runs-on: ubuntu-latest
     steps:
       - name: Download all artifacts
@@ -151,7 +166,7 @@ jobs:
       - name: Move all package files to files/
         run: |
           mkdir files
-          mv windows_wheels/* wheels/* sdist/* files/
+          mv windows_wheels/* macos_linux_wheels/* sdist/* files/
 
       - name: Publish on PyPI
         if: github.event.inputs.target == 'pypi' || github.event_name == 'release'
@@ -171,7 +186,7 @@ jobs:
           repository-url: https://test.pypi.org/legacy/
 
   open_failure_issue:
-    needs: [build_windows_wheels, build_wheels, build_sdist]
+    needs: [build_windows_wheels, build_macos_and_linux_wheels, build_sdist]
     name: Open an issue if build fails
     if: ${{ always() && contains(needs.*.result, 'failure') }}
     runs-on: ubuntu-latest

CMakeLists.txt

@@ -64,26 +64,34 @@ if (NOT DEFINED USE_PYTHON_CASADI)
   set(USE_PYTHON_CASADI TRUE)
 endif()
 
+# Use importlib to find the casadi path without importing it. This is useful
+# to find the path for the build-time dependency, not the run-time dependency.
 execute_process(
     COMMAND "${PYTHON_EXECUTABLE}" -c
-    "import casadi as _; print(_.__path__[0])"
+    "import importlib.util; print(importlib.util.find_spec('casadi').submodule_search_locations[0])"
     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}")
+  message("Found Python casadi path: ${CASADI_DIR}")
 endif()
 
 if(${USE_PYTHON_CASADI})
-  message("Trying to link against python casadi package")
+  message("Trying to link against Python casadi package")
   find_package(casadi CONFIG PATHS ${CASADI_DIR} REQUIRED)
 else()
-  message("Trying to link against any casadi package apart from the python one")
+  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
+)
+
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR})
 # Sundials
 find_package(SUNDIALS REQUIRED)