Skip to content

Commit 67c87e1

Browse files
Update README.md
1 parent b2faec5 commit 67c87e1

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ The `graphnics` library solves network models using the finite element method. T
1616
- [Vasomotion in arterial trees](https://github.com/IngeborgGjerde/graphnics/blob/main/demo/Vasomotion%20in%20arterial%20trees.ipynb)
1717
- [Solving coupled 3d-1d network models](https://github.com/IngeborgGjerde/graphnics/blob/main/demo/Coupled%201d-3d.ipynb) using `fenics_ii`
1818

19+
## Runtimes
20+
The library `fenics_ii` has been used for the implementation as it provides rapid and robust assembly of mixed-dimensional problems. The runtimes for the most computationally expensive model is shown here:
21+
- [Profiling](https://github.com/IngeborgGjerde/graphnics/blob/main/demo/Tree%20profiling.ipynb)
22+
1923
## Installation
2024
We use `networkx` combined with the mixed-dimensional library [`fenics_ii`](https://github.com/MiroK/fenics_ii) created by Miroslav Kuchta.
2125

@@ -42,10 +46,23 @@ docker logs graphnics-container
4246
```
4347
and enter the html-links it provides in your browser.
4448

45-
## Paper
49+
## Citation
4650

4751
This code is currently being prepared for submission to JOSS, titled:
4852

4953
*Graphnics: Combining networkx and FEniCS to solve network models* by Ingeborg Gjerde
5054

5155
The paper draft can be found [here.](https://github.com/IngeborgGjerde/graphnics/blob/main/paper/joss.md)
56+
57+
You can cite the repo using arxiv preprint
58+
```
59+
@article{graphnics2022gjerde,
60+
author = {{Gjerde}, Ingeborg G.},
61+
title = "{Graphnics: Combining FEniCS and NetworkX to simulate flow in complex networks}",
62+
journal = {arXiv e-prints},
63+
year = 2022,
64+
month = dec,
65+
archivePrefix = {arXiv},
66+
eprint = {2212.02916}}
67+
```
68+

0 commit comments

Comments
 (0)