Add documentation for example models #1025
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
MaHaWo
commented
Jan 29, 2025
- adds a section in the docs that treats example models
- gives a short description for each model, which function it showcases and, where not too long and unwieldy, the mathematical formulation
- liver-simplified and circadian rythm models are based on papers and are complex mathematically, hence they are not spelled out in all detail. If they should be modified at some point (i.e., the models themselves), the description could be updated with that?
for more information, see https://pre-commit.ci
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1025 +/- ##
==========================================
+ Coverage 90.45% 90.47% +0.01%
==========================================
Files 130 130
Lines 13586 13632 +46
==========================================
+ Hits 12289 12333 +44
- Misses 1297 1299 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
for more information, see https://pre-commit.ci
…tial-model-editor/spatial-model-editor into add-documentation-for-example-models
for more information, see https://pre-commit.ci
lkeegan
reviewed
Jan 30, 2025
…tial-model-editor/spatial-model-editor into add-documentation-for-example-models
|
should be done now, if you want to give it another look @lkeegan |
lkeegan
approved these changes
Jan 30, 2025
fix typo Co-authored-by: Liam Keegan <[email protected]>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.