Skip to content

Commit

Permalink
Made wavefiles.tar.gz description in resources.md more clear
Browse files Browse the repository at this point in the history
  • Loading branch information
mjg0 committed Dec 26, 2023
1 parent ed075b4 commit dce1cc4
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ wget https://rc.byu.edu/course/wavefiles.tar.gz
tar xf wavefiles.tar.gz
```

Within the resultant `wavefiles` directory are three helpful binaries: `wavesolve`, `waveshow`, and `wavediff`. `wavesolve` is a reference solver that works with up to 8 dimensions. `waveshow` prints wave orthotope files in human-readable form. `wavediff` checks whether two wave orthotope files represent the same wave orthotope. Call each with `--help` as the only argument to learn how to use them.
Within the resultant `wavefiles/bin` directory are three helpful binaries: `wavesolve`, `waveshow`, and `wavediff`. `wavesolve` is a reference solver that works with up to 8 dimensions. `waveshow` prints wave orthotope files in human-readable form. `wavediff` checks whether two wave orthotope files represent the same wave orthotope. Call each with `--help` as the only argument to learn how to use them.

You'll also find many wave orthotope files from 1 to 8 dimensions (in case you're doing the [extra credit](assignments/extra-credit.md#project)). Files with "`in`" in their names are input files, initialized and with simulation time zero; the corresponding "`out`" files are correct output files. As an example, `2d-small-out.wo` is the same wave orthotope as the one represented by `2d-small-in.wo`, but after solving. The `*large*` input files are zipped to save space and don't have corresponding output files since they're meant for benchmarking, not testing correctness. You could test your implementation using these two files by running your solver on the input file:
You'll also find many wave orthotope files from 1 to 8 dimensions (in case you're doing the [extra credit](assignments/extra-credit.md#project)), stored in the directories `1D`, `2D`, etc. Files with "`in`" in their names are input files, initialized and with simulation time zero; the corresponding "`out`" files are correct output files. The `*large*` input files are zipped to save space and don't have corresponding output files since they're only meant for benchmarking, and will need to be unzipped before use.

As an example, `2d-small-out.wo` is the same wave orthotope as the one represented by `2d-small-in.wo`, but after solving. You could test your implementation using these two files by running your solver on the input file:

```shell
./wavesolve_serial 2d-small-in.wo my-2d-small-out.wo
Expand Down

0 comments on commit dce1cc4

Please sign in to comment.