Skip to content

Commit 9c486ee

Browse files
committed
Update readme
1 parent 0242672 commit 9c486ee

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,27 @@
55

66
Simulate and visualize Swarzschild black holes, based on the methods described in Luminet (1979).
77

8-
![Example plot of a black hole](https://raw.githubusercontent.com/bgmeulem/luminet/master/assets/bh_plot.png)
8+
![Example plot of a black hole](docs/_static/_images/bh.png)
9+
<div style="display:flex">
10+
<div style="flex:1;padding-right:10px;">
11+
<img src="docs/_static/_images/isoradials.png" width="200"/>
12+
</div>
13+
<div style="flex:1;padding-left:10px;">
14+
<img src="docs/_static/_images/isoredshifts.png" width="300"/>
15+
</div>
16+
<div style="flex:1;padding-left:10px;">
17+
<img src="docs/_static/_images/isofluxlines.png" width="400"/>
18+
</div>
19+
</div>
920
</div>
1021

1122
## ⚡ Install
12-
`luminet` is available from PyPI:
13-
23+
`luminet` is available from [PyPI](https://pypi.org/project/luminet/) and [Anaconda](https://anaconda.org/bgmeulem/luminet):
1424
```shell
15-
pip install luminet
25+
pixi add --pypi luminet
1626
```
1727

28+
1829
## 📖 [Documentation](https://luminet.readthedocs.io/en/latest/index.html)
1930

2031
## 🔩 Usage
@@ -25,7 +36,7 @@ All variables in this repo are in natural units: $G=c=1$
2536
from luminet.black_hole import BlackHole
2637
bh = BlackHole(
2738
mass=1,
28-
incl=1.5, # inclination in radians
39+
incl=1.4, # inclination in radians
2940
acc=1, # accretion rate
3041
outer_edge=40
3142
)

0 commit comments

Comments
 (0)