Deltares / Deltares/imod-python
[FEATURE] - Add reporting functionality
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 12
- Avg merge
- 21h 8m
- Merged PRs (30d)
- 1
Description
In GitLab by @Huite on Jul 5, 2019, 13:49
We should probably create a
.reportnamespace. This provides a number of functions which automatically prepare these kinds of outputs. As seen above, the implementation is not particularly difficult using current methods, but it's nice to have an overview up and ready.Step 1 is defining the methods. Step 2 is writing a function which does the analysis. Step 3 is generating a HTML report (should be trivial using modern libraries like jinja2). Step 4 could be adding an interactive component on top.
Originally posted by @Huite in #77
I was cleaning up the board and found this old, but gold, idea. Consolidating this under an issue name with clearer scope, so that we're less likely to overlook this idea.
Contributor guide
No contributing guide indexed for this repository
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
No files, tests, or entry points are named. Start by surveying the existing methods and reporting-related functionality, then clarify the scope of the proposed .report namespace, analysis functions, HTML output, and possible interactive component. Done should be defined before implementation begins.
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