Skip to content

Commit 5b57b50

Browse files
committed
Update docs
1 parent 8268b93 commit 5b57b50

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,48 @@
11
# IDAKLU solver
22

3-
Standalone repository for the IDAKLU solver used in PyBaMM
3+
Standalone repository for the C/C++ solvers used in PyBaMM
44

55
## Installation
66

77
```bash
88
pip install pybammsolvers
99
```
10+
11+
## Solvers
12+
13+
The following solvers are available:
14+
- PyBaMM's IDAKLU solver
15+
16+
## Local builds
17+
18+
For testing new solvers and unsupported architectures, local builds are possible.
19+
20+
### Nox
21+
22+
Nox can be used to do a quick build:
23+
```bash
24+
pip install nox
25+
nox
26+
```
27+
This will setup an environment and attempt to build the library.
28+
29+
### MacOS
30+
31+
Mac dependencies can be installed using brew
32+
```bash
33+
brew install libomp
34+
brew reinstall gcc
35+
python install_KLU_Sundials.py
36+
pip install .
37+
```
38+
39+
### Linux
40+
41+
Linux installs may vary based on the distribution, however, the basic build can
42+
be performed with the following commands:
43+
```bash
44+
sudo apt-get libopenblas-dev gcc gfortran make g++ build-essential
45+
pip install cmake casadi setuptools wheel
46+
python install_KLU_Sundials.py
47+
pip install .
48+
```

0 commit comments

Comments
 (0)