isce-framework / isce-framework/dolphin
Add a `dolphin plot` option with some summary plots
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 153
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
It seems like having a dolphin plot to run after dolphin run would be good to inspect the results, quality check, etc.
- We could have a
plot/folder at that has it's own optional requirements - This might be a good use for papermill to run some pre-made jupyter notebook and pass the parameters of the output file locations
- We could make things interactive if we have it run a jupyter notebook, like having a covariance-matrix-plotter that responds to clicks
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 tracing the existing dolphin run command and the project's current output locations. Define the scope for a dolphin plot command, including which summary plots and output parameters are required, then evaluate the proposed plot/ folder, optional requirements, and papermill-based notebook workflow. Done means the feature's command interface, plot set, dependency behavior, and output handling are specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- cli, data-visualization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100