Skip to content

Commit

Permalink
docs(readme): correct layout and add instructions for single test
Browse files Browse the repository at this point in the history
  • Loading branch information
amyheather committed Jan 30, 2025
1 parent 5affc17 commit 0b2b6b0
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14622466.svg)](https://doi.org/10.5281/zenodo.14622466)
[![Tests](https://github.com/pythonhealthdatascience/rap_template_python_des/actions/workflows/tests.yaml/badge.svg)](https://github.com/pythonhealthdatascience/rap_template_python_des/actions/workflows/tests.yaml)

<br>A template for creating **discrete-event simulation (DES)** models in Python<br>
within a **reproducible analytical pipeline (RAP)**. <br><br>
<br>A template for creating **discrete-event simulation (DES)** models in Python within a **reproducible analytical pipeline (RAP)**. <br><br>
Click on <kbd>Use this template</kbd> to initialise new repository.<br>
A `README` template is provided at the **end of this file**.

Expand Down Expand Up @@ -156,6 +155,12 @@ To run tests in parallel -
pytest -n auto
```

To run a specific test:

```
pytest tests/testfile.py -k 'testname'
```

The repository contains a GitHub action `tests.yaml` which will automatically run tests with new commits to GitHub. This is continuous integration, helping to catch bugs early and keep the code stable. It will run the tests on three operating systems: Ubuntu, Windows and Mac.

If you have changed the model behaviour, you may wish to amend, remove or write new tests.
Expand Down

0 comments on commit 0b2b6b0

Please sign in to comment.