v4.0.0

💫 Towards Sharing Tools and Artifacts for Reusable Simulation: deploying a simpy model as a web app v4.0.0

Overview

This model is part of the ongoing STARS 2.0 study. An early version of the model presented here was part of STARS version 1.0. The code and written materials here demonstrate the application of STARS version 1 to sharing a simpy discrete-event simulation model and associated research artifacts.

• All artifacts in this repository are linked to study researchers via ORCIDs;
• Model code is made available under the MIT license;
• Python dependencies are managed through conda;
• The code builds a streamlit web application that can be used to run the model (web app);
• The materials are deposited and made citetable using Zenodo;
• The models are sharable with other researchers and the NHS without the need to install software.

What's Changed

Modifications to help improve user experience and clarity of the application and repository.

Added

• Created scripts/ folder and moved functions to that folder (to organise repository and prevent duplication of functions between pages)
• Add config.toml to ensure consistent theme for users with multiple apps or global config settings
• Add treat_sim to environment to import model (rather than using local model file)
• Created function to set page configuration on every page of app, including NIHR logo in sidebar
• Add Zenodo badges for each version in CHANGES.md
• Add Andy Mayne's ORCID and STARS logo to About page
• Add Towards paper to citation page and add Amy to CITATION.cff
• Add more description to interactive simulation (help statements for each parameter, labelled process flow diagram, and step-by-step instructions)
• Add instructions for using the Upload experiments page (including display of template scenarios.csv)

Changed

• Made files PEP-8 compliant and consistent use of " / '
• Upgraded environment to streamlit==1.35.0 (to use new features like st.logo())
• read_file_contents() uses local import (to prevent accidentally importing from deprecated development branches)
• Used headings, bullets, bold text and images to Overview page to help break up paragraph of text. This includes the arrival figure which was moved from the Interactive Simulation page, as it is not used when choosing model parameters but is relevant to the overview description of the model

Removed

• Removed model.py
• Removed duplicate or unused functions from more_plot.py
• Moved several unused files to archive/: copy_table.py, gcp.yml, git_update.sh, more_plot.ipynb, and more_plot.png
• Deleted CHANGES.md.backup

Fixed

• Saved preset experiment and uploaded experiments to session state so they are not lost between page changes
• Fixed bugs with download button (where table for preset experiments disappears if click button) and copy button (which required workaround for streamlit bug) by displaying results using st.dataframe() which has built-in download button and is easy to copy to clipboard using Ctrl+A

v3.1.0

💫 Towards Sharing Tools and Artifacts for Reusable Simulation: deploying a simpy model as a web app v3.1.0

Overview

The materials and methods in this repository support work towards developing the S.T.A.R.S healthcare framework (Sharing Tools and Artifacts for Reusable Simulations 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 simulation model and associated research artifacts.

• All artifacts in this repository are linked to study researchers via ORCIDs;
• Model code is made available under the MIT license;
• Python dependencies are managed through conda;
• The code builds a streamlit web application that can be used to run the model (web app);
• The materials are deposited and made citetable using Zenodo;
• The models are sharable with other researchers and the NHS without the need to install software.

What's Changed

This is a minor release with a small change in visual appearance.

• The process flow diagram presented in the interactive page has been fixed and updated.

v3.0.1

💫 Towards Sharing Tools and Artifacts for Reusable Simulation: deploying a simpy model as a web app v3.0.1

Overview

The materials and methods in this repository support work towards developing the S.T.A.R.S healthcare framework (Sharing Tools and Artifacts for Reusable Simulations 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 the MIT license;
• Python dependencies are managed through conda;
• The code builds a streamlit web application that can be used to run the model (web app);
• 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.

What's Changed

This is a minor release with 2 small patches.

• PATCH: Trauma patient treatment fixed to use the correct distribution and parameters
• PATCH: Tramna and non-trauma pathways updated to self internal instance of Scenario class as opposed to module level variable.

v3.0.0

💫 Towards Sharing Tools and Artifacts for Reusable Simulation: deploying a simpy model as a web app v3.0.0

Overview

The materials and methods in this repository support work towards developing the S.T.A.R.S healthcare framework (Sharing Tools and Artifacts for Reusable Simulations 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 the MIT license;
• Python dependencies are managed through conda;
• The code builds a streamlit web application that can be used to run the model (web app);
• 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.

What's Changed

• ENV: plotly v5.21.0 added.
• ENV: Arrival rate and MORE plot have been migrated to be interactive plotly format.
• MODULE: more_plot.py updated to include a more_plotly function.
• PAGES: Multiple replications setting moved from side bar to main window and converted to text input in 🎱 Interactive Simulation page.
• PAGES: Creation of Resources app page. Migration of Links from About page.
• PAGES: Creation of Changes app page: logging all major, minor and patched releases of the app.
• PAGES: About page cleaned up and linked to STARS main study and team.
• PAGES: Emojis 😀 added to app internal page names

v2.2.0

Changes

• ABOUT: added links to Github, Zenodo, Tutorial material, ORCIDs
• LICENSE: added MIT license page
• ENV: upgraded to streamlit 1.33 and simpy 4.1.1

v2.1.0

New in version 2.1.0

• Upgraded internal implementation of generating non-overlapping random number streams. This is now implemented to use np.random.SeedSequence. See https://numpy.org/doc/stable/reference/random/parallel.html

Patches

• Removed deprecated use of st.@cache decorator.

v2.0.0

The materials and methods in this repository support work towards developing the S.T.A.R.S healthcare framework (Sharing Tools and Artifacts for Reusable Simulations 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 the MIT license;
• Python dependencies are managed through conda;`
• The code builds a streamlit web application that can be used to run the model (web app);
• 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.

New in version 2.0.0

• Upgraded to Python 3.10 and upgrade numpy, pandas, matplotlib etc.
• Upgraded to streamlit 1.31.1
• Removed deprecated streamlit functions

Bug fixes

• Fixed st.setup_page location in Overview.py (main landing page) to avoid runtime error.

v1.2.0

The materials and methods in this repository support work towards developing the S.T.A.R.S healthcare framework (Sharing Tools and Artifacts for Reusable Simulations 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 the MIT license;
• Python dependencies are managed through conda;`
• The code builds a streamlit web application that can be used to run the model (web app);
• 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.

New in version 1.2.0

• Detailed instructions to run the model locally
• Updated app URLs including redundancy.