We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
2 parents 6849029 + 19196f4 commit 42f8687Copy full SHA for 42f8687
1 file changed
README.md
@@ -11,15 +11,25 @@ repository](https://github.com/landonjmitchell/openmc-plotgui)).
11
12
OpenMC, Matplotlib, NumPy, PySide2
13
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
24
## Usage
25
26
From a directory containing a working OpenMC model run:
27
28
```console
-python /path/to/openmc-plotter
29
+openmc-plotter
30
```
31
-Press `?` to view a variety of keyboard shortcuts.
32
+Once the viewer has opened, press `?` to view a variety of keyboard shortcuts.
33
34
# Controls/Functionality
35
0 commit comments