Skip to content

Commit 4558a09

Browse files
committed
Restructure README.
1 parent 71ba5e7 commit 4558a09

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,32 +24,6 @@ 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-
5327
## Basic usage
5428

5529
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.
@@ -288,3 +262,29 @@ It has the analytical solution $y_1(t) = t^4 e^{-t}$, $y_2(t) = t^3 e^{-t} (4 -
288262
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.
289263

290264
![Kvaerno_work_precision](https://raw.githubusercontent.com/JonasBreuling/scipy_dae/main/data/img/Kvaerno_work_precision.png)
265+
266+
## Install
267+
### Install through pip
268+
To install scipy-dae package you can run the command
269+
```
270+
pip install scipy-dae
271+
```
272+
273+
### Install through git repository
274+
To install the package through git installation you can download the repository and install it through
275+
```
276+
pip install .
277+
```
278+
279+
### Install for developing and testing
280+
An editable developer mode can be installed via
281+
282+
```bash
283+
python -m pip install -e .[dev]
284+
```
285+
286+
The tests can be started using
287+
288+
```bash
289+
python -m pytest --cov
290+
```

0 commit comments

Comments
 (0)