memilio
memilio copied to clipboard
897 new add initialization method from flows for lct model 1
Changes and Information
Please briefly list the changes (main added features, changed items, or corrected bugs) made:
- added functionality to compute an initial vector for the LCT-SECIR model based on flows
If need be, add additional information and what the reviewer should look out for in particular:
- This PR should be reviewed after PR #1004 as it is based on it.
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
- [x] Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
- [x] New code adheres to coding guidelines
- [x] No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
- [x] Tests are added for new functionality and a local test run was successful (with and without OpenMP)
- [x] Appropriate documentation for new functionality has been added (Doxygen in the code and Markdown files if necessary)
- [x] 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 #897.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 96.27%. Comparing base (
d439941
) to head (0181407
).
Additional details and impacted files
@@ Coverage Diff @@
## main #1005 +/- ##
==========================================
+ Coverage 96.24% 96.27% +0.03%
==========================================
Files 127 128 +1
Lines 10886 10992 +106
==========================================
+ Hits 10477 10583 +106
Misses 409 409
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
I was thinking that initializer_subcompartments might be a more suitable name than initializer_flows as you are calculating initial values of the subcompartments for given flows.
I do not think that initializer_subcompartments is a better name, because e.g. the realistic initialization also initializes subcompartments. The naming should include that we are using flows for initialization.
The LCT model has been updated in the meantime, so small changes had to be made here