ImperialCollegeLondon / ImperialCollegeLondon/SWMManywhere
Calculate `storevars` from `metric_list`
Open
Nobody has claimed this yet.
enhancements
good first issue
- Dominant language
- Python
- Stars
- 51
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Based on what metrics are included, you should be able to work out what variables to store in simulation. e.g., if no flow metrics are used, no need to store flow. Probably this means that the `metrics.register` needs to check for some information around required `storevars`
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the metrics.register entry point and tracing how storevars is currently selected for a simulation. Determine how registered metrics map to required stored variables, then verify that simulations no longer store variables unused by the selected metrics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, performance
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100