Skip to content

Commit

Permalink
Documentation additions
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-ashe committed Sep 28, 2023
1 parent ddfa98b commit a8882aa
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 14 additions & 1 deletion documentation/proc-pages/usage/plotting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

<h2>Plotting an MFILE</h2>

`plot_proc` is used for plotting an MFILE. It can be run using its own CLI:
<h3>Summary document</h3>
`plot_proc` is used for plotting an overview of the results from an MFILE. It can be run using its own CLI:

```bash
python process/io/plot_proc.py -f path/to/MFILE.DAT
Expand All @@ -12,4 +13,16 @@ or through Process's main CLI (working, but still in development):

```bash
process -i path/to/IN.DAT --plot --mfile path/to/MFILE.DAT
```
<h3>Radial build</h3>

`plot_radial_build` is to plot the radial build of the machine in terms of bar segments. It can be run as follows:

```bash
python process/io/plot_radial_build.py -f path/to/MFILE.DAT
```
<figure markdown>
![radial_build_plot](../../images/radial_build_plot.png){ width="100%"}
<figcaption>Figure 1: Simple radial build plot </figcaption>
</figure>

0 comments on commit a8882aa

Please sign in to comment.