Skip to content

Commit

Permalink
Add instructions for running tests.
Browse files Browse the repository at this point in the history
  • Loading branch information
jeannielynnmoulton committed Jul 25, 2024
1 parent 306f2ce commit d19d603
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,16 @@ Random seeds are set per simulation through a .txt file. Each line of the text f

**Note**: Additional files runIU.csv, dummy_visualizations.R and vis_functions.R were previously used for post-processing of results and can be safely ignored

## Running project tests

The project has tests in the directory `tests` and they are driven using `ctest` and written using the `Catch2` framework.

You need to have Catch2 install on your system, and the instructions for doing this are found on the [Catch2 Github page](https://github.com/catchorg/Catch2/blob/devel/docs/cmake-integration.md#installing-catch2-from-git-repository).

To run the tests, go to `build/tests` and run `ctest`. This will execute the tests and give a brief report.

To add new tests, add the test files to `TESTS_TO_RUN` in `tests/CMakeLists.txt`.

## Contributing

### Add new cpp files
Expand Down

0 comments on commit d19d603

Please sign in to comment.