NatLabRockies / NatLabRockies/H2Integrate
Add a check or warning when annual production statistics are based on a small simulation length
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Add a check or warning when annual production statistics are based on a small simulation length
This has come up in a few code standups before, but if we're to allow different simulation lengths, we need to make it clear to the user when certain metrics may not be representative of system performance.
A simple example is if someone simulates a solar PV system for a week in June and H2I reports an LCOE with that level of generation extrapolated to the whole year.
A good solution would take user's expectations for reasonable behavior in mind.
If you simulate for 1+ years, AEP or other annual metrics are fine.
Proposed solution
For shorter simulations, should we:
- print a warning to screen?
- throw an error? (seems extreme)
- not compute annual metrics
- something else?
Alternatives considered
Additional context
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 locating the code that computes annual metrics such as AEP and LCOE from simulation results. Review how simulation length is represented, then determine and document the expected behavior for simulations shorter than one year; the issue is done when one clear policy is agreed and implemented with coverage for short and 1+ year simulations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100