NatLabRockies / NatLabRockies/H2Integrate
Add waterfall plotting capability
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Add waterfall plotting capability
People keep asking for waterfall plots! I keep making them ad hoc. They sometimes look like this:
We should add a generalized way to produce these plots, though I admit it'll be challenging to make this easy-to-use and flexible enough for a lot of uses.
Proposed solution
We should probably create two scripts in an example case to do this.
One script would:
- run multiple user-defined cases, at a minimum two
- save off specific parameters and values defined by the user in the script into a pkl or similar
The other script would:
- have user-selected parameters that are what's varied between the cases
- have user-defined breakdowns for the stackups
- user selects the bars that are broken down vs. just showing the change
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
The issue names no existing files, tests, or entry points. Start by surveying the repository for plotting examples and determine where the two proposed example scripts belong; done should include a generalized waterfall workflow covering multiple cases, user-selected parameters and stackup breakdowns.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100