Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pythonhealthdatascience/stars-simpy-example-docs
STARS Project: Example `simpy` model documentation using JupyterBook, GitHub Pages, and STRESS
https://github.com/pythonhealthdatascience/stars-simpy-example-docs
discrete-event-simulation documentation jupyterbook model-reuse open-science reporting reproducible-research simpy
Last synced: 7 days ago
JSON representation
STARS Project: Example `simpy` model documentation using JupyterBook, GitHub Pages, and STRESS
- Host: GitHub
- URL: https://github.com/pythonhealthdatascience/stars-simpy-example-docs
- Owner: pythonhealthdatascience
- License: mit
- Created: 2023-08-08T14:24:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T16:30:55.000Z (8 months ago)
- Last Synced: 2024-05-22T16:33:57.011Z (8 months ago)
- Topics: discrete-event-simulation, documentation, jupyterbook, model-reuse, open-science, reporting, reproducible-research, simpy
- Language: Jupyter Notebook
- Homepage: https://pythonhealthdatascience.github.io/stars-simpy-example-docs/
- Size: 5.18 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
[](https://mybinder.org/v2/gh/pythonhealthdatascience/stars-simpy-example-docs/HEAD)
[](https://doi.org/10.5281/zenodo.11102373)
[](https://opensource.org/licenses/MIT)
[](https://www.python.org/downloads/release/python-3100+/)
[](https://pythonhealthdatascience.github.io/stars-simpy-example-docs)
[](https://orcid.org/0000-0001-5274-5037)
[](https://orcid.org/0000-0003-2631-4481)
[
](https://hub.docker.com/r/tommonks01/treat_sim)
# Towards Sharing Tools and Artifacts for Reusable Simulation: example enhanced documentation for a `simpy` model.
## Overview
The materials and methods in this repository support work towards developing the S.T.A.R.S healthcare framework (**S**haring **T**ools and **A**rtifacts for **R**eusable **S**imulations in healthcare). The code and written materials here demonstrate the application of S.T.A.R.S' version 1 to sharing a `simpy` discrete-event simuilation model and associated research artifacts.
* All artifacts in this repository are linked to study researchers via ORCIDs;
* Model code is made available under a MIT license;
* Python dependencies are managed through `conda`;`
* The python code itself can be viewed and executed in Jupyter notebooks via [Binder](https://mybinder.org);
* The model is documented and explained in a [Jupyter book website](https://pythonhealthdatascience.github.io/stars-simpy-example-docs) served up by GitHub pages;
* The materials are deposited and made citatable using Zenodo;
* The models are sharable with other researchers and the NHS without the need to install software.
## Author ORCIDs
[](https://orcid.org/0000-0001-5274-5037)
[](https://orcid.org/0000-0003-2631-4481)
## Citation
> Monks, T., & Harper, A. (2024). Towards Sharing Tools and Artifacts for Reusable Simulation: example enhanced documentation for a `simpy` model. (v1.1.2). Zenodo. https://doi.org/10.5281/zenodo.11102373
```bibtex
@software{stars_example_docs,
author = {Monks, Thomas and
Harper, Alison},
title = {{Towards Sharing Tools and Artifacts for Reusable
Simulation: example enhanced documentation for a
`simpy` model.}},
month = may,
year = 2024,
publisher = {Zenodo},
version = {v1.1.2},
doi = {10.5281/zenodo.11102373},
url = {https://doi.org/10.5281/zenodo.11102373}
}
```
## Funding
This code is part of independent research supported by the National Institute for Health Research Applied Research Collaboration South West Peninsula. The views expressed in this publication are those of the author(s) and not necessarily those of the National Institute for Health Research or the Department of Health and Social Care.
## Case study model
**This example is based on exercise 13 from Nelson (2013) page 170.** Please also credit this work is you use our materials.
> *Nelson. B.L. (2013). [Foundations and methods of stochastic simulation](https://www.amazon.co.uk/Foundations-Methods-Stochastic-Simulation-International/dp/1461461596/ref=sr_1_1?dchild=1&keywords=foundations+and+methods+of+stochastic+simulation&qid=1617050801&sr=8-1). Springer.*
We adapt a textbook example from Nelson (2013): a terminating discrete-event simulation model of a U.S based treatment centre. In the model, patients arrive to the health centre between 6am and 12am following a non-stationary Poisson process. On arrival, all patients sign-in and are triaged into two classes: trauma and non-trauma. Trauma patients include impact injuries, broken bones, strains or cuts etc. Non-trauma include acute sickness, pain, and general feelings of being unwell etc. Trauma patients must first be stabilised in a trauma room. These patients then undergo treatment in a cubicle before being discharged. Non-trauma patients go through registration and examination activities. A proportion of non-trauma patients require treatment in a cubicle before being discharged. The model predicts waiting time and resource utilisation statistics for the treatment centre. The model allows managers to ask question about the physical design and layout of the treatment centre, the order in which patients are seen, the diagnostic equipment needed by patients, and the speed of treatments. For example: “what if we converted a doctors examination room into a room where nurses assess the urgency of the patients needs.”; or “what if the number of patients we treat in the afternoon doubled”
## Online Notebooks via Binder
The python code for the model has been setup to run online in Jupyter notebooks via binder [](https://mybinder.org/v2/gh/pythonhealthdatascience/stars-ciw-example/HEAD)
> Binder is a free service. If it has not been used in a while Binder will need to re-containerise the code repository, and push to binderhub. This will take several minutes. After that the online environment will be quick to load.
## Online documentation produced by Jupyter-book
[](https://pythonhealthdatascience.github.io/stars-simpy-example-docs)
* The documentation can be access at [https://pythonhealthdatascience.github.io/stars-simpy-example-docs](https://pythonhealthdatascience.github.io/stars-simpy-example-docs)
## How to create the website locally
Alternatively you may wish to create the website on your local machine.
### Downloading the code
Either clone the repository using git or click on the green "code" button and select "Download Zip".
```bash
git clone https://github.com/pythonhealthdatascience/stars-simpy-example-docs
```
### Installing dependencies
[](https://www.python.org/downloads/release/python-360+/)
All dependencies can be found in `binder/environment.yml` and are pulled from conda-forge. To run the code locally, we recommend install [mini-conda](https://docs.conda.io/en/latest/miniconda.html); navigating your terminal (or cmd prompt) to the directory containing the repo and issuing the following command:
```bash
conda env create -f binder/environment.yml
```
To activate the environment issue the following command:
```bash
conda activate stars_docs
```
### Building the book
In the directory (folder) containing the code (i.e. where `_toc.yml` and `_config.yml` are located), issue the following command via the terminal (or cmd prompt/powershell on windows)
```bash
jb build .
```
> The configuration of the book has been setup to re-run all of the notebooks. It may take a few minutes to execute on your local machine.
When the build is complete Jupyter book will display a hyper-link to the book that has been built on your machine. Click on the link (or copy paste into a browser) to run it.