From 41149a053ba89799f5920d48252df37e554108b6 Mon Sep 17 00:00:00 2001 From: blakeaw Date: Thu, 30 Jan 2025 15:40:58 -0600 Subject: [PATCH] Added additional details about testing and coverage analysis dependencies to CONTRIBUTING and README. --- CONTRIBUTING.md | 6 ++++++ README.md | 12 +++++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a953577..af4361a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) diff --git a/README.md b/README.md index d8365e4..dd6e4be 100644 --- a/README.md +++ b/README.md @@ -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