Skip to content

Commit

Permalink
Added additional details about testing and coverage analysis dependen…
Browse files Browse the repository at this point in the history
…cies to CONTRIBUTING and README.
  • Loading branch information
blakeaw committed Jan 30, 2025
1 parent 26af63d commit 41149a0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ If you want to contribute code that fixes bugs or adds new features you can fork

However, before doing so, please ask first. You can do so by commenting on the relevant Issue. This helps prevent duplicated or wasted efforts.

Note that for automated testing and coverage analysis requires the following:
[pytest](https://docs.pytest.org/en/stable/getting-started.html), [Coverage.py](https://coverage.readthedocs.io/en/7.6.10/install.html), and [nose](https://nose.readthedocs.io/en/latest/).
```
pip install pytest coverage nose
```

PR contribution steps:

1. [Fork the repo](https://github.com/blakeaw/pysb-pkpd/fork)
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,18 @@ __`pysb-pkpd` enables you to efficiently program and simulate dynamic PK/PD and
### Dependencies

Note that `pysb-pkpd` has the following core dependencies:
* [PySB](https://pysb.org/) - developed using PySB version 1.15.0
* [PySB](https://pysb.org/) - developed using PySB version 1.15.0, and recommended to install using conda/mamba.
```
conda install -c alubbock pysb
```

For automated testing and coverage analysis:
* [pytest](https://docs.pytest.org/en/stable/getting-started.html)
* [Coverage.py](https://coverage.readthedocs.io/en/7.6.10/install.html)
* [nose](https://nose.readthedocs.io/en/latest/)
```
pip install pytest coverage nose
```

### pip install

Expand Down

0 comments on commit 41149a0

Please sign in to comment.