Skip to content

Commit 219a609

Browse files
committed
chore(release): update changelog and citation.cff
1 parent a112065 commit 219a609

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

CHANGELOG.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,44 @@ 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.0.0 - 2025-01-27
9+
10+
Lots and lots of changes! Many of these are a result of comments from peer review of code by Tom Monks.
11+
12+
### Added
13+
14+
* Virtual environment alternative to conda.
15+
* Bash script to lint repository.
16+
* Lots of new unit tests and functional tests!
17+
* GitHub actions to run tests and lint repository.
18+
* Add `MonitoredResource` and alternative warm-up results collection.
19+
* Time-weighted statistics - including relevant code (`replications.py`), documentation (`choosing_replications.ipynb`), and tests (`_replications` in tests).
20+
* User-controlled interactive histogram of results in `analysis.ipynb`.
21+
* Add metrics for unseen patients.
22+
23+
### Changed
24+
25+
* Changes to code and environment to accomodate new features (described in 'Added').
26+
* Import simulation as a local package.
27+
* Save all tables and figures.
28+
* Add Tom Monks to author list.
29+
* Expanded README.
30+
* Renaming classes and variables (e.g. `Trial` to `Runner`, `Defaults` to `Param`).
31+
* Improved log formatting.
32+
* Moved methods (e.g. from `analysis.ipynb` to `simulation/`).
33+
* Re-arranged tests into unit tests, back tests and functional tests.
34+
35+
### Fixed
36+
37+
* First arrival no longer at time 0.
38+
* Begin interval audit at start of data collection period (rather than start of warm-up period).
39+
* Correct logging message where wrong time was used.
40+
* Add error handling for invalid cores (in model + test) and error message for attempts to log when in parallel.
41+
* Resolved runtime warning with handling for variance 0 in `summary_stats()`.
42+
* Prevent output of standard deviation or confidence intervals from `summary_stats()` when n<3.
43+
* Add error handling for results processing when there are no arrivals.
44+
* Add error handling for invalid mean in `Exponential`.
45+
846
## v0.1.0 - 2025-01-09
947

1048
🌱 First release of the python DES template.

CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ abstract: >-
2626
within a reproducible analytical pipeline (RAP).
2727
license: MIT
2828
# TODO: Manually update with each GitHub release
29-
version: '0.1.0'
30-
date-released: '2025-01-09'
29+
version: '1.0.0'
30+
date-released: '2025-02-27'

0 commit comments

Comments
 (0)