simpy-streamlit-tutorial

Building DES models in simpy and streamlit

https://github.com/health-data-science-or/simpy-streamlit-tutorial

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 10 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Building DES models in simpy and streamlit

Basic Info
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 2
  • Open Issues: 1
  • Releases: 8
Created over 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.md

Binder License: MIT Python 3.10+ Read the Docs License: MIT License: MIT

Improving the usability of open health service delivery simulation models using python and web apps

Overview

The materials and methods in this repository support health service researchers learning to use simpy and streamlit to build open discrete-event simulation models. The models are sharable with other researchers and the NHS.

Author ORCIDs

ORCID: Harper ORCID: Monks

Dependencies

Python 3.10+

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; navigating your terminal (or cmd prompt) to the directory containing the repo and issuing the following command:

conda env create -f binder/environment.yml

Online Alternatives:

Read the Docs

  • Visit our jupyter book for interactive code and explanatory text
  • Run out Jupyter notebooks in binder Binder

Citation

If you use the work contained in the repository for your research or job then a citation would be very welcome when you write up.

Citing the journal article

We have a journal article that accompanies this repo published in NIHR open research: https://openresearch.nihr.ac.uk/articles/3-48

Monks T and Harper A. Improving the usability of open health service delivery simulation models using Python and web apps [version 2; peer review: 3 approved]. NIHR Open Res 2023, 3:48 (https://doi.org/10.3310/nihropenres.13467.2)

```bibtex @article{monksharper2023improving, title={Improving the usability of open health service delivery simulation models using Python and web apps}, author={Monks, T and Harper, A}, journal={NIHR Open Research}, volume={3}, pages={48}, year={2023}, url={https://doi.org/10.3310/nihropenres.13467.2}, doi={10.3310/nihropenres.13467.2}, note={Version 2; Peer Review: 3 Approved} }

```

Citing the code

Please cite the code and work in this repository as follows:

Monks, Thomas, & Harper, Alison. (2023). SimPy and StreamLit Tutorial Materials for Healthcare Discrete-Event Simulation (v1.1.2). Zenodo. https://doi.org/10.5281/zenodo.8193001

bibtex @software{monks_thomas_2023_8193001, author = {Monks, Thomas and Harper, Alison}, title = {{SimPy and StreamLit Tutorial Materials for Healthcare Discrete-Event Simulation}}, month = jul, year = 2023, publisher = {Zenodo}, version = {v1.1.2}, doi = {10.5281/zenodo.8193001}, url = {https://doi.org/10.5281/zenodo.8193001} }

Repo Overview

``` . ├── binder │   └── environment.yml ├── CITATION.cff ├── config.yml ├── content │   ├── 01setup │   ├── 02simpy │   ├── 03streamlit │   ├── 04exercises │   ├── 05solutions │   └── front_page.md ├── imgs ├── LICENSE ├── main.py ├── README.md └── _toc.yml

```

  • binder - contains the environment.yml file (sim) and all dependencies managed via conda
  • _config.yml - configuration of our Jupyter Book
  • content - the notebooks and markdown arranged by setup, simpy, streamlit, exercises, and solutions.
  • data - directory containing data files used by analysis notebooks.
  • imgs - all image files used in the tutorial material
  • LICENSE - details of the MIT permissive license of this work.
  • main.py - an example simpy model to use to test the virtual environment
  • README - what you are reading now!
  • _toc.yml - the table of contents for our Jupyter Book.

Owner

  • Name: Health Data Science and Operations Research
  • Login: health-data-science-OR
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  SimPy and StreamLit Tutorial Materials for Healthcare
  Discrete-Event Simulation
type: software
authors:
  - given-names: Thomas
    family-names: Monks
    affiliation: University of Exeter
    orcid: 'https://orcid.org/0000-0003-2631-4481'
  - given-names: Alison
    family-names: Harper
    affiliation: University of Exeter
    orcid: 'https://orcid.org/0000-0001-5274-5037'
identifiers:
  - type: doi
    value: 10.5281/zenodo.8159080
  - type: url
    value: 'https://zenodo.org/record/8159080'
repository-code: >-
  https://github.com/health-data-science-OR/simpy-streamlit-tutorial
url: >-
  https://health-data-science-or.github.io/simpy-streamlit-tutorial
keywords:
  - Discrete-event simulation
  - Health services research
  - Open science
  - streamlit
  - simpy
  - ciw
  - simulation
license: MIT

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Issues and Pull Requests

Last synced: almost 2 years ago

All Time
  • Total issues: 1
  • Total pull requests: 20
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 20
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • TomMonks (1)
Pull Request Authors
  • TomMonks (20)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/docker-publish.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action 3b5e8027fcad23fda98b2e3ac259d8d67585f671 composite
  • docker/login-action f4ef78c080cd8ba55a85445d5b36e214a81df20a composite
  • docker/metadata-action 9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 composite
Dockerfile docker
  • python 3.9-slim build
content/03_streamlit/requirements.txt pypi
  • matplotlib ==3.3.4
  • numpy >=1.19.2
  • pandas >=1.2.3
  • plotly *
  • scipy ==1.6.1
  • simpy ==4.0.1
  • st-files-connection ==0.1.0
  • streamlit ==1.27.2
binder/environment.yml conda
  • jupyterlab 3.5.3.*
  • jupyterlab-spellchecker 0.7.3.*
  • matplotlib 3.7.1.*
  • numpy 1.25.0.*
  • pandas 2.0.2.*
  • pip 23.1.2.*
  • plotly 5.15.0.*
  • python 3.9.16.*
  • scipy 1.10.1.*
  • simpy 4.0.1.*