Skip to content

Commit 49e9ae1

Browse files
committed
chore(readme): added citation info
1 parent d51ca35 commit 49e9ae1

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Dates formatted as YYYY-MM-DD as per [ISO standard](https://www.iso.org/iso-8601-date-and-time-format.html).
77

8-
## [v0.1.0 - Date](https://github.com/pythonhealthdatascience/intro-open-sim/releases/tag/v0.1.0) - [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13971859.svg)](https://doi.org/10.5281/zenodo.13971859)
8+
## [v0.1.0 - 22/10/2024](https://github.com/pythonhealthdatascience/intro-open-sim/releases/tag/v0.1.0) - [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13971859.svg)](https://doi.org/10.5281/zenodo.13971859)
99

1010
🌱 Initial release of tutorial materials.
1111

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77

88
# An introduction to Discrete-Event Simulation (DES) using Free and Open Source Software
99

10-
> Work in progress. This is a STARS project being prepared for the [Operational Research Society 12th Simulation Workshop in 2025 (SW25)](https://www.theorsociety.com/ORS/ORS/Events/2025/Simulation-Workshop/SW25.aspx). It has been adapted from our [template repository](https://github.com/pythonhealthdatascience/stars-simpy-jupterlite) for sharing `simpy` models with JupyterLite.
10+
> Work in progress. This is tutorial was initially prepared for the [Operational Research Society 12th Simulation Workshop in 2025 (SW25)](https://www.theorsociety.com/ORS/ORS/Events/2025/Simulation-Workshop/SW25.aspx). It has been adapted from our [template repository](https://github.com/pythonhealthdatascience/stars-simpy-jupterlite) for sharing `simpy` models with JupyterLite.
1111
1212
## 🧑‍💻 1. Tutorial
1313

14-
We being with two notebooks that introduce some basic concepts for creating DES in python:
14+
We begin with two notebooks that introduce some basic concepts for creating DES in python:
1515

1616
* `01_sampling.ipynb`: Sampling from statistical distributions using `numpy`
1717
* `02_basic_simpy.ipynb`: Creating simple `simpy` DES models that make use of `numpy` sampling
@@ -72,7 +72,22 @@ jupyter-lab
7272

7373
## 📝 3. Citation
7474

75-
TBC.
75+
```bibtex
76+
@software{open_sim_tutorial,
77+
author = {Monks, Thomas and
78+
Harper, Alison and
79+
Heather, Amy},
80+
title = {An introduction to Discrete-Event Simulation using
81+
Free and Open Source Software.
82+
},
83+
month = oct,
84+
year = 2024,
85+
publisher = {Zenodo},
86+
version = {v0.1.0},
87+
doi = {10.5281/zenodo.13971859},
88+
url = {https://doi.org/10.5281/zenodo.13971859},
89+
}
90+
```
7691

7792
## 🤝 4. Acknowledgements
7893

0 commit comments

Comments
 (0)