Skip to content

Conversation

@HenrZu
Copy link
Contributor

@HenrZu HenrZu commented Sep 29, 2025

Changes and Information

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

  • Implement influenza model from doi.org/10.1186/s12879-017-2344-6 into our framework
  • Add flowchart and rtd documentation

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 within the code (Doxygen) for new functionality has been added in the code
  • Appropriate external documentation (ReadTheDocs) for new functionality has been added to the online documentation
  • 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).

@HenrZu HenrZu linked an issue Sep 29, 2025 that may be closed by this pull request
2 tasks
@codecov
Copy link

codecov bot commented Oct 6, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.29%. Comparing base (a1d8af8) to head (9fd5e08).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main    #1387    +/-   ##
========================================
  Coverage   97.28%   97.29%            
========================================
  Files         175      178     +3     
  Lines       15306    15635   +329     
========================================
+ Hits        14891    15212   +321     
- Misses        415      423     +8     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@HenrZu HenrZu requested a review from annawendler October 6, 2025 21:10
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 really good! :) Most of my comments are regarding naming of variables/parameters where I made some suggestions.

@HenrZu HenrZu requested a review from annawendler October 29, 2025 07:47
@HenrZu HenrZu mentioned this pull request Oct 30, 2025
2 tasks
@HenrZu HenrZu linked an issue Oct 30, 2025 that may be closed by this pull request
2 tasks
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.

There are several conversations that you resolved without making any changes or commenting. Can you add comments where you disagree so we can discuss?

- ``SeasonalityAmplitude``
- Amplitude of the seasonal modulation :math:`\exp(\delta\,\sin(2\pi(t/52 - t_z + t_s)))`.
* - :math:`t_z`
- ``ShiftTZ``
Copy link
Member

Choose a reason for hiding this comment

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

Some of the parameter names need to be updated.

*
* We assume that no one is initially infected or exposed at the beginning of the season.
* Infections are seeded later via the OutsideFoI parameter.
* The destinction into the 2 layers of susceptibility is done via the parameters.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* The destinction into the 2 layers of susceptibility is done via the parameters.
* The distinction into the 2 layers of susceptibility is done via the parameters.

};

/**
* @brief Transition/recovery rate in 1/week.
Copy link
Member

Choose a reason for hiding this comment

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

I would prefer two separate parameters for the transitions and then setting it equal in the example since it allows more flexibility for the user.

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.

Implement influenza model Implement an influenza model

3 participants