Remove python-idaklu (#4326)

* Remove references in python to python-idaklu, edit tests

* Remove relevant C++ files

* style: pre-commit fixes

* Fix coverage

* remove unused function

* Add warning for sensitivities with python evaluator
style fixes from review

* Add to changelog

* fix test name

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -16,6 +16,10 @@
 - Fixed memory issue that caused failure when `output variables` were specified with (`IDAKLUSolver`). ([#4379](https://github.com/pybamm-team/PyBaMM/issues/4379))
 - Fixed bug where IDAKLU solver failed when `output variables` were specified and an event triggered. ([#4300](https://github.com/pybamm-team/PyBaMM/pull/4300))
 
+## Breaking changes
+
+- Removed legacy python-IDAKLU solver. ([#4326](https://github.com/pybamm-team/PyBaMM/pull/4326))
+
 # [v24.5](https://github.com/pybamm-team/PyBaMM/tree/v24.5) - 2024-07-26
 
 ## Features

CMakeLists.txt

@@ -92,8 +92,6 @@ pybind11_add_module(idaklu
   src/pybamm/solvers/c_solvers/idaklu/IdakluJax.hpp
   src/pybamm/solvers/c_solvers/idaklu/common.hpp
   src/pybamm/solvers/c_solvers/idaklu/common.cpp
-  src/pybamm/solvers/c_solvers/idaklu/python.hpp
-  src/pybamm/solvers/c_solvers/idaklu/python.cpp
   src/pybamm/solvers/c_solvers/idaklu/Solution.cpp
   src/pybamm/solvers/c_solvers/idaklu/Solution.hpp
   src/pybamm/solvers/c_solvers/idaklu/Options.hpp

setup.py

@@ -323,8 +323,6 @@ def compile_KLU():
         "src/pybamm/solvers/c_solvers/idaklu/IdakluJax.hpp",
         "src/pybamm/solvers/c_solvers/idaklu/common.hpp",
         "src/pybamm/solvers/c_solvers/idaklu/common.cpp",
-        "src/pybamm/solvers/c_solvers/idaklu/python.hpp",
-        "src/pybamm/solvers/c_solvers/idaklu/python.cpp",
         "src/pybamm/solvers/c_solvers/idaklu/Solution.cpp",
         "src/pybamm/solvers/c_solvers/idaklu/Solution.hpp",
         "src/pybamm/solvers/c_solvers/idaklu/Options.hpp",

src/pybamm/models/base_model.py

@@ -39,6 +39,7 @@ class BaseModel:
         calling `evaluate(t, y)` on the given expression treeself.
         - "casadi": convert into CasADi expression tree, which then uses CasADi's \
         algorithm to calculate the Jacobian.
+        - "jax": convert into JAX expression tree
 
         Default is "casadi".
     """

src/pybamm/solvers/base_solver.py

@@ -1514,26 +1514,13 @@ def report(string):
     elif model.convert_to_format != "casadi":
         y = vars_for_processing["y"]
         jacobian = vars_for_processing["jacobian"]
-        # Process with pybamm functions, converting
-        # to python evaluator
+
         if model.calculate_sensitivities:
-            report(
-                f"Calculating sensitivities for {name} with respect "
-                f"to parameters {model.calculate_sensitivities}"
+            raise pybamm.SolverError(  # pragma: no cover
+                "Sensitivies are no longer supported for the python "
+                "evaluator. Please use `convert_to_format = 'casadi'`, or `jax` "
+                "to calculate sensitivities."
             )
-            jacp_dict = {
-                p: symbol.diff(pybamm.InputParameter(p))
-                for p in model.calculate_sensitivities
-            }
-
-            report(f"Converting sensitivities for {name} to python")
-            jacp_dict = {
-                p: pybamm.EvaluatorPython(jacp) for p, jacp in jacp_dict.items()
-            }
-
-            # jacp should be a function that returns a dict of sensitivities
-            def jacp(*args, **kwargs):
-                return {k: v(*args, **kwargs) for k, v in jacp_dict.items()}
 
         else:
             jacp = None

src/pybamm/solvers/c_solvers/idaklu.cpp

@@ -11,7 +11,6 @@
 #include "idaklu/idaklu_solver.hpp"
 #include "idaklu/IdakluJax.hpp"
 #include "idaklu/common.hpp"
-#include "idaklu/python.hpp"
 #include "idaklu/Expressions/Casadi/CasadiFunctions.hpp"
 
 #ifdef IREE_ENABLE
@@ -34,28 +33,6 @@ PYBIND11_MODULE(idaklu, m)
 
   py::bind_vector<std::vector<np_array>>(m, "VectorNdArray");
 
-  m.def("solve_python", &solve_python,
-    "The solve function for python evaluators",
-    py::arg("t"),
-    py::arg("y0"),
-    py::arg("yp0"),
-    py::arg("res"),
-    py::arg("jac"),
-    py::arg("sens"),
-    py::arg("get_jac_data"),
-    py::arg("get_jac_row_vals"),
-    py::arg("get_jac_col_ptr"),
-    py::arg("nnz"),
-    py::arg("events"),
-    py::arg("number_of_events"),
-    py::arg("use_jacobian"),
-    py::arg("rhs_alg_id"),
-    py::arg("atol"),
-    py::arg("rtol"),
-    py::arg("inputs"),
-    py::arg("number_of_sensitivity_parameters"),
-    py::return_value_policy::take_ownership);
-
   py::class_<IDAKLUSolver>(m, "IDAKLUSolver")
   .def("solve", &IDAKLUSolver::solve,
     "perform a solve",