Skip to content

Commit 33b8b5c

Browse files
committed
adds a readme
1 parent 6ecfcde commit 33b8b5c

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Requirements
2+
============
3+
4+
`deal.II` with development headers
5+
6+
Usage
7+
=====
8+
9+
```
10+
git clone --recurse-submodules https://github.com/pymor/pymor-deal.II
11+
cd pymor-deal.II
12+
python -m pip install pymor
13+
python -m pip install -e .
14+
python test/demo.py
15+
```
16+
17+
18+
Development notes
19+
=================
20+
21+
We have a `pre-commit` config that is also run/checked in CI.
22+
Python source is formatted with `black`.
23+
C++ source is formatted with `clang-format`.

0 commit comments

Comments
 (0)