Release v0.0.5 (#15)

* Update version

* Attempt to use brew instead

* Try removing arm logic

* Switch deployment target

* Try ignoring version

* Put version back

* Update code to match pybamm

* Update submodule url (#21)

* Revert a change

* Update docs

.github/workflows/build_wheels.yml

@@ -173,9 +173,9 @@ jobs:
 
             export SDKROOT=${SDKROOT:-$(xcrun --show-sdk-path)}
 
-            # Can't download LLVM-OpenMP directly, use conda/mamba and set environment variables
+            # Can't download LLVM-OpenMP directly, use conda and set environment variables
             brew install miniforge
-            mamba create -n pybammsolvers-dev $OPENMP_URL
+            conda create -n pybammsolvers-dev $OPENMP_URL
             if [[ $(uname -m) == "x86_64" ]]; then
               PREFIX="/usr/local/Caskroom/miniforge/base/envs/pybammsolvers-dev"
             elif [[ $(uname -m) == "arm64" ]]; then

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "pybind11"]
 	path = pybind11
-	url = git@github.com:pybind/pybind11.git
+	url = https://github.com/pybind/pybind11.git

README.md

@@ -1,9 +1,48 @@
 # IDAKLU solver
 
-Standalone repository for the IDAKLU solver used in PyBaMM
+Standalone repository for the C/C++ solvers used in PyBaMM
 
 ## Installation
 
 ```bash
 pip install pybammsolvers 
 ```
+
+## Solvers
+
+The following solvers are available:
+- PyBaMM's IDAKLU solver
+
+## Local builds
+
+For testing new solvers and unsupported architectures, local builds are possible.
+
+### Nox
+
+Nox can be used to do a quick build:
+```bash
+pip install nox
+nox
+```
+This will setup an environment and attempt to build the library.
+
+### MacOS
+
+Mac dependencies can be installed using brew
+```bash
+brew install libomp
+brew reinstall gcc
+python install_KLU_Sundials.py
+pip install .
+```
+
+### Linux
+
+Linux installs may vary based on the distribution, however, the basic build can
+be performed with the following commands:
+```bash
+sudo apt-get libopenblas-dev gcc gfortran make g++ build-essential
+pip install cmake casadi setuptools wheel
+python install_KLU_Sundials.py
+pip install .
+```

src/pybammsolvers/idaklu_source/IDAKLUSolverOpenMP.inl

@@ -192,6 +192,9 @@ void IDAKLUSolverOpenMP<ExprSet>::SetSolverOptions() {
   // Initial step size
   CheckErrors(IDASetInitStep(ida_mem, solver_opts.dt_init));
 
+  // Minimum absolute step size
+  CheckErrors(IDASetMinStep(ida_mem, solver_opts.dt_min));
+
   // Maximum absolute step size
   CheckErrors(IDASetMaxStep(ida_mem, solver_opts.dt_max));
 

src/pybammsolvers/idaklu_source/Options.cpp

@@ -142,6 +142,7 @@ SolverOptions::SolverOptions(py::dict &py_opts)
       max_order_bdf(py_opts["max_order_bdf"].cast<int>()),
       max_num_steps(py_opts["max_num_steps"].cast<int>()),
       dt_init(RCONST(py_opts["dt_init"].cast<double>())),
+      dt_min(RCONST(py_opts["dt_min"].cast<double>())),
       dt_max(RCONST(py_opts["dt_max"].cast<double>())),
       max_error_test_failures(py_opts["max_error_test_failures"].cast<int>()),
       max_nonlinear_iterations(py_opts["max_nonlinear_iterations"].cast<int>()),

src/pybammsolvers/idaklu_source/Options.hpp

@@ -31,6 +31,7 @@ struct SolverOptions {
   int max_order_bdf;
   int max_num_steps;
   double dt_init;
+  double dt_min;
   double dt_max;
   int max_error_test_failures;
   int max_nonlinear_iterations;

src/pybammsolvers/version.py

@@ -1 +1 @@
-__version__ = "0.0.4"
+__version__ = "0.0.5"