Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecation of "warmup" #100

Merged
merged 4 commits into from
Oct 7, 2024
Merged

Deprecation of "warmup" #100

merged 4 commits into from
Oct 7, 2024

Conversation

twallema
Copy link
Owner

@twallema twallema commented Oct 7, 2024

  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have updated the documentation accordingly.

Describe your fixes/additions/changes

What was warmup?

"warmup" was a legacy feature from the COVID-19 pandemic, it was a parameter (int/float or date) that could be given to the sim function, allowing the simulation to start prior to the start date. Its value could be calibrated to determine when an epidemic was seeded.

It has persisted until now because it didn't harm anyone.

Why remove warmup?

  • PR Initial condition functions #99 can be used instead. Users wanting to use this epi-legacy-feature can just infer the initial number of infected in their epi models to find similar results.
  • To keep the code clean and as easily accessible as possible.

@twallema twallema merged commit 72bb501 into master Oct 7, 2024
2 checks passed
@twallema twallema deleted the get-warmup-out branch October 7, 2024 21:00
@twallema twallema mentioned this pull request Oct 9, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant