Skip to content

Commit 4548503

Browse files
authored
[Enhancement/Documentation] README Update (#131)
* Update the README to reflect the latest version of RESPOND * Update unit testing badge source URL * Remove unnecessary elements from script path * Remove repository-local pull request template
1 parent 538f5b2 commit 4548503

File tree

2 files changed

+14
-23
lines changed

2 files changed

+14
-23
lines changed

.github/pull_request_template.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
# :warning: NOTICE :warning:
2-
3-
This repository is under active development and is not currently in a state for public use. If you wish to use RESPOND, please refer to release [v0.3.0](https://github.com/SyndemicsLab/respond/releases/tag/v0.3.0) for a functioning executable.
4-
51
# RESPOND: An Opioid Use Disorder State Transition Model
62

73
<a href="https://www.syndemicslab.org/respond"><img align="right" src="https://github.com/SyndemicsLab/.github/blob/main/profile/images/RESPOND.png" alt="RESPOND Logo" height="120" /></a>
84

95
[![Docs](https://github.com/SyndemicsLab/respond/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/SyndemicsLab/respond/actions/workflows/deploy-docs.yml)
10-
[![Tests](https://github.com/SyndemicsLab/respond/actions/workflows/test-ubuntu.yml/badge.svg)](https://github.com/SyndemicsLab/respond/actions/workflows/unit-testing.yml)
6+
[![Tests](https://github.com/SyndemicsLab/respond/actions/workflows/unit-testing.yml/badge.svg)](https://github.com/SyndemicsLab/respond/actions/workflows/unit-testing.yml)
117
![Endpoint Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMJC598%2F10e746e28df5d23e91689b01493435a0%2Fraw%2Frespond-cobertura-coverage.json)
128

139
This is the home of the [RESPOND model](https://syndemicslab.github.io/respond) [1], first created by the [Syndemics Lab](https://www.syndemicslab.org) in 2018, now rewritten with a focus on four primary goals:
@@ -73,7 +69,7 @@ From there, a simple
7369

7470
```bash
7571
sudo dpkg -i respond-xxx.deb
76-
```
72+
```
7773

7874
command will result in the appropriate installation. The only files added are the public headers, the compiled static library, and the CMake configuration files.
7975

@@ -103,8 +99,19 @@ target_link_libraries(${PROJECT_NAME}
10399
If you would prefer a single bash script to add the project to the build tree, run:
104100

105101
```shell
106-
./tools/build.sh
102+
tools/build.sh
107103
```
108104

105+
## Running RESPOND
106+
107+
The recommended way to use the RESPOND model is via the [Python
108+
package][respondpy], with [source on GitHub][respondpy-git].
109+
110+
If you wish to use RESPOND via a local executable, please refer to release
111+
[v0.3.0](https://github.com/SyndemicsLab/respond/releases/tag/v0.3.0).
112+
109113
## References
110114
1. Madushani RWMA, Wang J, Weitz M, Linas BP, White LF, Chrysanthopoulou SA (2025) Empirical calibration of a simulation model of opioid use disorder. PLoS ONE 20(3): e0310763. https://doi.org/10.1371/journal.pone.0310763
115+
116+
[respondpy]: https://pypi.org/project/respondpy/
117+
[respondpy-git]: https://github.com/SyndemicsLab/respondpy

0 commit comments

Comments
 (0)