Skip to content
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.

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

Create toplevel hydrolib.core.io.dflowfm tree structure for FMModel input #258

Closed
priscavdsluis opened this issue Jun 27, 2022 · 2 comments · Fixed by #392
Closed

Create toplevel hydrolib.core.io.dflowfm tree structure for FMModel input #258

priscavdsluis opened this issue Jun 27, 2022 · 2 comments · Fixed by #392
Labels
type: enhancement Improvements to existing functionality
Milestone

Comments

@priscavdsluis
Copy link
Contributor

What is the need for this task.
Currently in hydrolib.core.io many subdirectories exist for FM related modules.
One subdirectory in hydrolib.core.io is meant for RR modules.
hydrolib.core.io has grown a bit messy because of this.

What is the task?
Move all FM related subdirecties in hydrolib.core.io to hydrolib.core.io.dflowfm

Additional context
Changing the namespace for all FM objects might require a lot of rework in the documentation and code that is dependent on it.

See #168 for RR

@priscavdsluis priscavdsluis added the type: enhancement Improvements to existing functionality label Jun 27, 2022
@priscavdsluis
Copy link
Contributor Author

We should also consider updating and using the init.py files to make imports easier as advised by @BeardedPlatypus

@tim-vd-aardweg
Copy link
Contributor

Eventhough all the work for this issue has been done, we decided to wait until the next release to actually merge it, because this issue will obviously cause all sorts of merge conflicts.

It may be quicker to start this issue from scratch after the release, than to fix all the merge conflicts.

priscavdsluis pushed a commit that referenced this issue Oct 31, 2022
Refs: #258

BREAKING CHANGE: Moved all dflowfm related modules to a new dflowfm folder, breaking all the existing imports to the affected modules.
@priscavdsluis priscavdsluis added this to the Release 0.4 milestone Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Improvements to existing functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants