Skip to content

Commit

Permalink
Merge branch '24-repo-structure' into 105-readthedocsapi
Browse files Browse the repository at this point in the history
  • Loading branch information
barneydobson committed Mar 26, 2024
2 parents 5b8828c + 0d1f9b1 commit 8404783
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ python we want to use, but you can use any other tool you are familiar with.
Just make sure you use a version of Python compatible with SWMManywhere.

```bash
conda create --name wsimod python=3.10
conda create --name swmmanywhere python=3.10
conda activate swmmanywhere
```

Expand All @@ -64,7 +64,7 @@ the conflicts. To install the development dependencies and then `SWMManywhere`
in development mode run:

```bash
pip install -r requirements-dev.txt
pip install -r dev-requirements.txt
pip install -e .
```

Expand Down Expand Up @@ -108,6 +108,14 @@ pytest # run all tests
pytest tests/test_file.py # run a specific file's tests
```

By default the `tests/tests_prepare_data.py` does not test the actual downloads
themselves (since this relies on external APIs actually working at the time of
testing), however downloads can be enabled when testing:

```bash
pytest tests/tests_prepare_data.py -m downloads
```

You can check the coverage for these tests by running:

```bash
Expand Down

0 comments on commit 8404783

Please sign in to comment.