Skip to content

946 implement generalized linear chain trick#1058

Merged
annawendler merged 34 commits intomainfrom
946-implement-generalized-linear-chain-trick
Nov 26, 2024
Merged

946 implement generalized linear chain trick#1058
annawendler merged 34 commits intomainfrom
946-implement-generalized-linear-chain-trick

Conversation

@lenaploetzke
Copy link
Member

@lenaploetzke lenaploetzke commented Jun 27, 2024

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

  • Added a GLCT-SECIR model (generalized linear chain trick model) that allows to use phase-type distributed stay times in the compartments.
  • Added tests.
  • Moved calculate_compartments function from the LCT model to the lct_infection_state such that the GLCT model can use the function as well.

If need be, add additional information and what the reviewer should look out for in particular:

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

  • Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
  • New code adheres to coding guidelines
  • No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • Tests are added for new functionality and a local test run was successful (with and without OpenMP)
  • Appropriate documentation for new functionality has been added (Doxygen in the code and Markdown files if necessary)
  • Proper attention to licenses, especially no new third-party software with conflicting license has been added
  • (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

  • Corresponding issue(s) is/are linked and addressed
  • Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
  • Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
  • No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

Closes #946.

@lenaploetzke lenaploetzke added the model::lct Models using the linear chain trick label Jun 27, 2024
@lenaploetzke lenaploetzke self-assigned this Jun 27, 2024
@codecov
Copy link

codecov bot commented Jun 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.98%. Comparing base (0962eb0) to head (6a612dc).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1058      +/-   ##
==========================================
+ Coverage   96.59%   96.98%   +0.39%     
==========================================
  Files         137      142       +5     
  Lines       11057    11868     +811     
==========================================
+ Hits        10680    11510     +830     
+ Misses        377      358      -19     
Flag Coverage Δ
?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lenaploetzke lenaploetzke requested a review from annawendler July 22, 2024 12:54
Copy link
Member

@annawendler annawendler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a very cool model! I think it would benefit from adding more documentation to make it easier to understand.

Copy link
Member

@annawendler annawendler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just some comments regarding spelling :)

@annawendler annawendler merged commit fc0ebaf into main Nov 26, 2024
@annawendler annawendler deleted the 946-implement-generalized-linear-chain-trick branch November 26, 2024 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

model::lct Models using the linear chain trick

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add the possibility to simulate phase-type distributed sojourn times in the LCT model

2 participants