|
2 | 2 |
|
3 | 3 | [](https://doi.org/10.5281/zenodo.6497477) |
4 | 4 |
|
5 | | -This book contains example documentation and open working for a computer simulation model. The model is a based on the treatment centre example in Nelson [1]. The model is implemented in `python` and `simpy`. |
| 5 | +This book contains example enhanced documentation and open working for a discrete-event simulation model. The model is a based on the treatment centre example in Nelson [1]. The model is implemented in `python` and `simpy`. |
6 | 6 |
|
7 | | -The book covers the following aspects of open working for simulation: |
| 7 | +## Towards Sharing Tools and Artifacts for Reuable Simulation: example enhanced documentation for a `simpy` model. |
8 | 8 |
|
9 | | -* Sharing your model code and parameters with other researchers and simulation modellers. |
10 | | -* An example of documenting your model using the STRESS reporting checklist (for DES). |
11 | | -* Providing a simple executable version of your model for other to verify results. |
| 9 | +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. |
12 | 10 |
|
13 | | -## Contributors |
| 11 | +* All artifacts in this repository are linked to study researchers via ORCIDs; |
| 12 | +* Model code is made available under a MIT license; |
| 13 | +* Python dependencies are managed through `conda`;` |
| 14 | +* The python code itself can be viewed and executed in Jupyter notebooks via [Binder](https://mybinder.org); |
| 15 | +* The model is documented and explained in a [Jupyter book website](https://pythonhealthdatascience.github.io/stars-simpy-examplar-docs) served up by GitHub pages; |
| 16 | +* The materials are deposited and made citatable using Zenodo; |
| 17 | +* The models are sharable with other researchers and the NHS without the need to install software. |
14 | 18 |
|
15 | | -* Thomas Monks, University of Exeter |
16 | | -* Alison Harper, University of Exeter |
17 | | -* Simon Taylor, Brunel University London |
18 | | -* Anastasia Anagnostou, Brunel University London |
| 19 | +## Author ORCIDs |
19 | 20 |
|
20 | | -## References |
21 | | - |
22 | | -1. *Nelson. B.L. (2013). [Foundations and methods of stochastic simulation: A first course](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.* |
| 21 | +[](https://orcid.org/0000-0001-5274-5037) |
| 22 | +[](https://orcid.org/0000-0003-2631-4481) |
0 commit comments