Skip to content

Commit 64a3535

Browse files
committed
chore(release): re-run notebooks + update citation.cff and changelog.md for release
1 parent d13efea commit 64a3535

File tree

8 files changed

+93
-39
lines changed

8 files changed

+93
-39
lines changed

CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,36 @@ 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.1.0 - 2025-03-21
9+
10+
Add a bash script for executing notebooks and new tests for warm-up patients and replication consistency. Fixes were made to correct notebook configurations, adjust test parameters, refine the replication algorithm, and ensure accurate calculations, such as correcting nurse time usage and setting appropriate values in the replication algorithm. Other changes include updates to default parameters and documentation.
11+
12+
### Added
13+
14+
* Bash script to execute all notebooks (with `nbconvert` add to environment for this).
15+
* Add test related to inclusion/exclusion of warm-up patients in certain metrics (`test_warmup_high_demand()`).
16+
* Add test for consistent `nreps` between replications methods.
17+
18+
### Changed
19+
20+
* Changed default warm-up length in `Param()`.
21+
* Add pylint line limit so it adheres to PEP-8.
22+
* Allow input of `Param()` to the objects in `replications.py` so we can specify parameter set for back tests (so they don't just change results when we change the model defaults).
23+
* Add specific parameters to `generate_exp_results.ipynb` for back tests.
24+
* Add acknowledgements to README and docstrings.
25+
* Lowered the default `min_rep` for both confidence_interval_method functions.
26+
27+
### Fixed
28+
29+
* Correct `choosing_warmup.ipynb` to use multiple replications and run length at least 5-10x actual.
30+
* Fix `test_waiting_time_utilisation()` **TODO:** DROP THIS?
31+
* Correct `test_klimit()` to actually use the parametrize inputs.
32+
* Add correction to `nurse_time_used` for when patients span the warm-up and data collection period.
33+
* Allow `None` for the dashed line in `plotly_confidence_interval_method()`.
34+
* Allow a solution below `initial_replications` in `ReplicationsAlgorithm`.
35+
* Set `target_met` back to 0 in `ReplicationsAlgorithm` if precision is no longer achieved.
36+
* Set `test_consistent_outputs()` to have no lookahead.
37+
838
## v1.0.0 - 2025-02-27
939

1040
Lots and lots of changes! Many of these are a result of comments from peer review of code by Tom Monks.

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: '1.0.0'
30-
date-released: '2025-02-27'
29+
version: '1.1.0'
30+
date-released: '2025-03-21'

notebooks/analysis.ipynb

Lines changed: 42 additions & 18 deletions
Large diffs are not rendered by default.

notebooks/choosing_cores.ipynb

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

notebooks/choosing_replications.ipynb

Lines changed: 10 additions & 10 deletions
Large diffs are not rendered by default.

notebooks/choosing_warmup.ipynb

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

notebooks/time_weighted_averages.ipynb

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

outputs/choose_param_cores.png

237 Bytes
Loading

0 commit comments

Comments
 (0)