|
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 | | - |
5 | 1 | # RESPOND: An Opioid Use Disorder State Transition Model |
6 | 2 |
|
7 | 3 | <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> |
8 | 4 |
|
9 | 5 | [](https://github.com/SyndemicsLab/respond/actions/workflows/deploy-docs.yml) |
10 | | -[](https://github.com/SyndemicsLab/respond/actions/workflows/unit-testing.yml) |
| 6 | +[](https://github.com/SyndemicsLab/respond/actions/workflows/unit-testing.yml) |
11 | 7 |  |
12 | 8 |
|
13 | 9 | 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 |
73 | 69 |
|
74 | 70 | ```bash |
75 | 71 | sudo dpkg -i respond-xxx.deb |
76 | | -``` |
| 72 | +``` |
77 | 73 |
|
78 | 74 | command will result in the appropriate installation. The only files added are the public headers, the compiled static library, and the CMake configuration files. |
79 | 75 |
|
@@ -103,8 +99,19 @@ target_link_libraries(${PROJECT_NAME} |
103 | 99 | If you would prefer a single bash script to add the project to the build tree, run: |
104 | 100 |
|
105 | 101 | ```shell |
106 | | -./tools/build.sh |
| 102 | +tools/build.sh |
107 | 103 | ``` |
108 | 104 |
|
| 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 | + |
109 | 113 | ## References |
110 | 114 | 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