Skip to content

[Enhancement/Documentation] README Update #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ddbaptiste merged 4 commits into from
Feb 18, 2026
Merged

[Enhancement/Documentation] README Update #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
74b8df8
Update the README to reflect the latest version of RESPOND
ddbaptiste Feb 18, 2026
421e33a
Update unit testing badge source URL
ddbaptiste Feb 18, 2026
3ef5137
Remove unnecessary elements from script path
ddbaptiste Feb 18, 2026
60e584b
Remove repository-local pull request template
ddbaptiste Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions .github/pull_request_template.md
View file
Open in desktop

This file was deleted.

21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
# :warning: NOTICE :warning:

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.

# RESPOND: An Opioid Use Disorder State Transition Model

<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>

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

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:
Expand Down Expand Up @@ -73,7 +69,7 @@ From there, a simple

```bash
sudo dpkg -i respond-xxx.deb
```
```

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

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

```shell
./tools/build.sh
tools/build.sh
```

## Running RESPOND

The recommended way to use the RESPOND model is via the [Python
package][respondpy], with [source on GitHub][respondpy-git].

If you wish to use RESPOND via a local executable, please refer to release
[v0.3.0](https://github.com/SyndemicsLab/respond/releases/tag/v0.3.0).

## References
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

[respondpy]: https://pypi.org/project/respondpy/
[respondpy-git]: https://github.com/SyndemicsLab/respondpy