Skip to content

Commit 9945a1f

Browse files
committed
Updates to README for the latest installation method.
1 parent 6849029 commit 9945a1f

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,22 @@ repository](https://github.com/landonjmitchell/openmc-plotgui)).
1111

1212
OpenMC, Matplotlib, NumPy, PySide2
1313

14+
## Installation
15+
16+
This package is most easily installed by running
17+
18+
```console
19+
pip install .
20+
```
21+
22+
from the top directory in the repository.
23+
1424
## Usage
1525

1626
From a directory containing a working OpenMC model run:
1727

1828
```console
19-
python /path/to/openmc-plotter
29+
openmc-plotter
2030
```
2131

2232
Press `?` to view a variety of keyboard shortcuts.

0 commit comments

Comments
 (0)