Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove flow module #1457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
JoerivanEngelen opened this issue Feb 25, 2025 · 1 comment · Fixed by #1458
Closed

Remove flow module #1457

JoerivanEngelen opened this issue Feb 25, 2025 · 1 comment · Fixed by #1458
Milestone
Epic: General mai...

Comments

@JoerivanEngelen
Copy link
Contributor

JoerivanEngelen commented Feb 25, 2025 •
edited
Loading

The flow module refers to code to generate iMODFLOW model. It is not used at all and iMODFLOW is phased out, so best to remove it and to reduce the complexity of the code base. It is only another hurdle for new developers to understand what is going on.

Remove:

  • flow module
  • Remove tests
  • Remove examples
  • Remove API docs and any crossrefs in the docs
@github-project-automation github-project-automation bot moved this to 📯 New in iMOD Suite Feb 25, 2025
@JoerivanEngelen JoerivanEngelen mentioned this issue Feb 25, 2025
Merged
5 tasks
@Huite
Copy link
Contributor

Huite commented Feb 25, 2025

That should clean up nicely!

Did any project even use this? ...

github-merge-queue bot pushed a commit that referenced this issue Feb 26, 2025
@JoerivanEngelen
Issue #1457 remove flow module (#1458)
e3909c2 
Fixes #1457 

Removes ``flow`` module, it has hardly seen any use. Reduces clutter,
scope, potential hurdles to getting familiar with the code base, and
potential maintenance.

# Description
- Remove ``flow`` module
- Remove unittests for ``flow``
- Remove iMODFLOW examples
- Remove notions that iMOD Python can generate iMODFLOW models from
README
- Update changelog, so that there are no crossrefs to be removed 

I also tested generating the docs, so that there are no errors thrown.

# Checklist
<!---
Before requesting review, please go through this checklist:
-->

- [x] Links to correct issue
- [x] Update changelog, if changes affect users
- [x] PR title starts with ``Issue #nr``, e.g. ``Issue #737``
- [ ] Unit tests were added
- [ ] **If feature added**: Added/extended example
@github-project-automation github-project-automation bot moved this from 📯 New to ✅ Done in iMOD Suite Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
iMOD Suite
Status: ✅ Done
Milestone
Epic: General maintenance
Development

Successfully merging a pull request may close this issue.

Issue #1457 remove flow module Deltares/imod-python
2 participants
@JoerivanEngelen @Huite