Skip to content

Commit 19e3a88

Browse files
authored
Merge pull request #111 from anshgupta1234/docs_update
2 parents 210ecac + d970dfe commit 19e3a88

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

docs/documentation/testing.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,13 @@ When pushing to the stack, or creating a new case with the `create_case` functio
7171
If a trace is empty (that is, the empty string `""`), it will not appear in the final trace, but any case parameter variations associated with it will still be applied.
7272

7373
Finally, the case is appended to the `cases` list, which will be returned by the `generate_cases` function.
74+
75+
### Testing Post Process
76+
77+
To test updated post process code, append the `-a` or `--test-all` option:
78+
```console
79+
$ ./mfc.sh test -a -j 8
80+
```
81+
82+
This argument will re-run the test stack with `parallel_io=True`, which generates silo_hdf5 files. It will also turn most write parameters (`*_wrt`) on. Then, it uses the [h5py](https://www.h5py.org/) library to ensure that there are no NaNs or Infinity's written to the silo files. Although adding this option does not guarantee that accurate silo files are generated, it does ensure that post process does not fail or produce malformed data.
83+

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<span id="release-ver"></span>
5151
</div>
5252
</a>
53-
<a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="documentation/md_getting_started.html">
53+
<a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="documentation/md_getting-started.html">
5454
<i class="pr-4 fa-solid fa-rocket"></i>
5555
<span class="flex-1">Getting Started</span>
5656
</a>

0 commit comments

Comments
 (0)