📝 clarify model script selection in generated outputs#19
Open
clorton wants to merge 1 commit into
Open
Conversation
Document that `--model` selects both the epidemiological model and the generated script name (`si.py`, `sir.py`, or `seir.py`). Update the README and user-facing guides to: - describe the default `seir.py` output more precisely - explain when to run `si.py` or `sir.py` instead - remove wording that implies only SEIR scripts are generated - note the documentation change in the changelog
There was a problem hiding this comment.
Pull request overview
This PR updates user-facing documentation to clarify that --model determines both the epidemiological model variant and the generated script filename.
Changes:
- Clarifies default
seir.pygeneration and SI/SIR alternatives across guides. - Updates run instructions to reference matching
si.py,sir.py, orseir.pyscripts. - Records the documentation clarification in the changelog.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Clarifies generated model script naming and execution guidance. |
| docs/userguide.md | Updates workflows and editing guidance for model-specific script names. |
| docs/troubleshooting.md | Clarifies replacing seir.py when troubleshooting SI/SIR scripts. |
| docs/quickstart.md | Updates quickstart output and run instructions for model variants. |
| docs/models.md | Adds script-name guidance for running different model variants. |
| docs/index.md | Clarifies the generated script can vary by --model. |
| docs/configuration.md | Updates custom config examples to mention all generated script names. |
| CHANGELOG.md | Notes the documentation clarification under Unreleased. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| python3 ./seir.py | ||
| ``` | ||
|
|
||
| If you generated a different model with `--model`, run `python3 ./si.py` or `python3 ./sir.py` instead. |
| ### Understanding Model Outputs | ||
|
|
||
| After running the generated model script (e.g., `seir.py`), you'll find several output plots: | ||
| After running the generated model script (for example, `seir.py`), you'll find several output plots: |
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
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.
Document that
--modelselects both the epidemiological model and the generated script name (si.py,sir.py, orseir.py).Update the README and user-facing guides to:
seir.pyoutput more preciselysi.pyorsir.pyinstead