Skip to content

Commit 5d9149a

Browse files
authored
Update README.md (#34)
Added pip installation instructions
1 parent 79f4f54 commit 5d9149a

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,32 @@ The [Kármán vortex street](https://en.wikipedia.org/wiki/K%C3%A1rm%C3%A1n_vort
2424

2525
[![Karman](https://github.com/user-attachments/assets/3f5202f7-7666-4e4a-94dc-26f0759abef7)](https://raw.githubusercontent.com/JonasBreuling/scipy_dae/main/data/img/von_Karman.gif)
2626

27+
## Install
28+
### Install through pip
29+
To install scipy-dae package you can run the command
30+
```
31+
pip install scipy-dae
32+
```
33+
34+
### Install through git repository
35+
To install the package through git installation you can download the repository and install it through
36+
```
37+
pip install .
38+
```
39+
40+
### Install for developing and testing
41+
An editable developer mode can be installed via
42+
43+
```bash
44+
python -m pip install -e .[dev]
45+
```
46+
47+
The tests can be started using
48+
49+
```bash
50+
python -m pytest --cov
51+
```
52+
2753
## Basic usage
2854

2955
The Robertson problem of semi-stable chemical reaction is a simple system of differential algebraic equations of index 1. It demonstrates the basic usage of the package.
@@ -262,17 +288,3 @@ It has the analytical solution $y_1(t) = t^4 e^{-t}$, $y_2(t) = t^3 e^{-t} (4 -
262288
Starting at $t_0 = 0.5$, this problem is solved for $atol = rtol = 10^{-(4 + m / 4)}$, where $m = 0, \dots, 32$. The resulting error at $t_1 = 1$ is compared with the elapsed time of the used solvers in the figure below.
263289

264290
![Kvaerno_work_precision](https://raw.githubusercontent.com/JonasBreuling/scipy_dae/main/data/img/Kvaerno_work_precision.png)
265-
266-
## Install
267-
268-
An editable developer mode can be installed via
269-
270-
```bash
271-
python -m pip install -e .[dev]
272-
```
273-
274-
The tests can be started using
275-
276-
```bash
277-
python -m pytest --cov
278-
```

0 commit comments

Comments
 (0)