Deltares / Deltares/ProbabilisticLibrary
Improve understandability of code base
Open
Nobody has claimed this yet.
Prob lib C++
Py wrapper
- Dominant language
- C++
- Stars
- 8
- Forks
- 1
- Avg merge
- 4d 18h
- Merged PRs (30d)
- 4
Description
Here are some suggestions to improve the understandability of the code base:
- Move Fortran related implementation out of the CWrapper project
- Focus on providing just a C, C++ and Python interface (No Fortran, no C++/CLI)
- Write out PWrapper to PythonWrapper
- Add technical design for the relationship of components (i.e. intended architecture)
- Move Python examples and Notebooks from the sources directory
- in-code documentation of interface methods.
- Remove NOT USED configurations from Team City
Reporter: @joelvdberg
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 the CWrapper project, PWrapper, the sources directory, Python examples and notebooks, interface methods, and Team City configurations. Start by mapping these components and their relationships against the listed suggestions. Done would require addressing the requested interface, layout, architecture, documentation, and configuration changes, but no specific files or tests are identified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, cpp, fortran, python
- Domain
- backend, build-system, developer-experience, documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100