Skip to content

Commit 86a866d

Browse files
committed
Fix Doxygen <tt> & Positional argument example
1 parent 5ea3d62 commit 86a866d

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/documentation/case.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ $ python3 my_case_file.py
2929

3030
This is particularly useful when computations are done in Python to generate the case.
3131

32-
## (Optional) Accepting command line arguments (from `mfc.sh run`)
32+
## (Optional) Accepting command line arguments
3333

3434
Input files can accept **positional** command line arguments, forwarded by `mfc.sh run`.
3535
Consider this example from the 3D_weak_scaling case:
@@ -55,6 +55,18 @@ We hide it from the help menu with `help=argparse.SUPPRESS` since it is not mean
5555
to be passed in by users. You can add as many additional positional arguments as
5656
you may need.
5757

58+
To run such a case, use the following format:
59+
60+
```console
61+
./mfc.sh run <path/to/case.py> <positional arguments> <regular mfc.sh run arguments>
62+
```
63+
64+
For example, to run the 3D_weak_scaling case with `gbpp=2`:
65+
66+
```console
67+
./mfc.sh run examples/3D_weak_scaling/case.py 2 -t pre_process -j 8
68+
```
69+
5870
## Parameters
5971

6072
There are multiple sets of parameters that must be specified in the python input file:

0 commit comments

Comments
 (0)