Towards Sharing Tools, Artefacts, and Reproducible Simulation: a ciw model examplar

Authors
Affiliation

Thomas Monks

University of Exeter

Alison Harper

University of Exeter

Amy Heather

University of Exeter

Abstract

The materials and methods in this documentation support work towards developing the S.T.A.R.S healthcare framework (Sharing Tools and Artefacts for Reproducible Simulations in healthcare). Long term S.T.A.R.S aims to support researchers share open simulation models regardless of language choice, improve the quality of sharing, and reduce the workload required to meet high standards of open science for the modelling and simulation community.

The code and written materials here demonstrate the application of S.T.A.R.S’ version 1 to sharing a ciw discrete-event simuilation model and associated research artefacts:

  • All artefacts in this repository are linked to study researchers via ORCIDs;
  • Model code is made available under a GNU Public License version 3;
  • Python dependencies are managed through conda;
  • The code builds a Shiny for Python web application that can be used to run the model (web app);
  • The python code itself can be viewed and executed in Jupyter notebooks via Binder;
  • The model is documented and explained in a quarto website 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.
Keywords

Discrete-event simulation, Open Science

Reuse

Citation

BibTeX citation:
@online{monks,
  author = {Monks, Thomas and Harper, Alison and Heather, Amy},
  title = {Towards {Sharing} {Tools,} {Artefacts,} and {Reproducible}
    {Simulation:} A `Ciw` Model Examplar},
  url = {https://pythonhealthdatascience.github.io/stars-ciw-example/},
  doi = {10.5281/zenodo.10051494},
  langid = {en},
  abstract = {The materials and methods in this documentation support
    work towards developing the **S.T.A.R.S healthcare framework**
    (**S**haring **T**ools and **A**rtefacts for **R**eproducible
    **S**imulations in healthcare). Long term S.T.A.R.S aims to support
    researchers share open simulation models regardless of language
    choice, improve the quality of sharing, and reduce the workload
    required to meet high standards of open science for the modelling
    and simulation community. The code and written materials here
    demonstrate the application of S.T.A.R.S’ version 1 to sharing a
    `ciw` discrete-event simuilation model and associated research
    artefacts: * All artefacts in this repository are linked to study
    researchers via ORCIDs; * Model code is made available under a GNU
    Public License version 3; * Python dependencies are managed through
    `conda`; * The code builds a Shiny for Python web application that
    can be used to run the model (web app); * 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 quarto website 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.}
}
For attribution, please cite this work as:
Monks, Thomas, Alison Harper, and Amy Heather. n.d. “Towards Sharing Tools, Artefacts, and Reproducible Simulation: A `Ciw` Model Examplar.” Zenodo. https://doi.org/10.5281/zenodo.10051494.