Skip to content

Commit dd64301

Browse files
committed
chore(release): update changelog, citation and init for release 1.3.0
1 parent b9c750d commit dd64301

File tree

3 files changed

+26
-8
lines changed

3 files changed

+26
-8
lines changed

CHANGELOG.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,33 @@ 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+
## v1.3.0 - 2025-08-05
89

9-
## Unreleased
10-
11-
Additional validation: Test simulation model against analytical queuing results
10+
This release introduces several new features including input modelling, code-based model validation, new key performance indicators, and more - as well as improvements to documentation and code.
1211

1312
### Added
1413

15-
* Analytical queuing model `MMSQueue` in `test/test_mms.py`
16-
* A small test suite for comparing long run simulation estimation of means to analytical results (to 3 dp with 0.15 relative tolerance). Tested L_q, L_s, W_q, W_s.
14+
* Created notebook generating a synthetic dataset.
15+
* Created notebook for input modelling using `distfit`.
16+
* Add mock paper.
17+
* Add `pytest-cov` and instructions for running with coverage.
18+
* Add code-based model validation, via tests comparing results against analytical queueing theory model.
19+
* Add two new metrics: mean time in system and time-weighted mean number of patients in system.
20+
* Add seed offset to allow change from use of run number.
21+
22+
### Changed
23+
24+
* Removed internal distributions and tests, switched to import `sim-tools` for these features (with corresponding tests in the `sim-tools` repo).
25+
* Amended `pyproject.toml` (include author name & description).
26+
* Renamed and replaced all "rap_template_python_des" with "pydesrap_mms", and moved away from "template" phrasing.
27+
* Simplified README so more relevant to repository content.
28+
* Moved each function/class into its own file.
29+
* Simplified and standardised NumPy style docstrings.
30+
* Changed default precision when choosing replications to 0.1.
31+
* Amend `run_notebooks.sh` so can use to run a single notebook.
32+
* Changed default number of replications to 15.
33+
* Can choose operating system when manually trigger tests GitHub action.
34+
* Add imports to `__init__.py` so can import using e.g. `from simulation import Model` rather than `from simulation.model import Model`.
1735

1836
## v1.2.0 - 2025-03-26
1937

CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ abstract: >-
2525
Reproducible analytical pipeline (RAP) for python discrete-event simulation
2626
(DES) implementing a simple M/M/s queueing model.
2727
license: MIT
28-
version: '1.2.0'
29-
date-released: '2025-03-26'
28+
version: '1.3.0'
29+
date-released: '2025-08-25'

simulation/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
SimPy Discrete-Event Simulation (DES) Model.
33
"""
44

5-
__version__ = "1.2.0"
5+
__version__ = "1.3.0"
66

77

88
# This section allows us to import using e.g. `from simulation import Model`,

0 commit comments

Comments
 (0)