Generate classes from dfns on get-modflow #2385
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ignore generated py and dfn files for generated classes
Supported: modflow6 as repository, or executables that contain mf6
deltamarnix
commented
Nov 29, 2024
| @@ -556,6 +561,10 @@ def add_item(key, fname, do_chmod): | |||
| items.append(fname) | |||
| if not fname.endswith(lib_suffix): | |||
| chmod.add(fname) | |||
|
|
|||
| if repo == "modflow6": | |||
There was a problem hiding this comment.
I wasn't able to get this working for the nightly builds, because there doesn't seem to be a reference from the nightly to which git commit of modflow was used to build it.
deltamarnix
commented
Nov 29, 2024
| @@ -31,6 +31,7 @@ requires-python = ">=3.9" | |||
| dependencies = [ | |||
| "numpy>=1.20.3", | |||
| "matplotlib >=1.4.0", | |||
| "modflow-devtools", | |||
There was a problem hiding this comment.
I'm not happy with this dependency, but it's how generate_classes currently downloads and unzips. Perhaps we should move it, or copy it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When calling get-modflow from the executables or the modflow6 repo, it will automatically generate the mf6 package, model, and simulation classes.
It is also possible to call
generate-mf6-classesdirectly as a command. So if you have your own dfn files stored somewhere, you can generate the classes using that folder.Changes
__init__.pyfile inflopy/mf6/modflow/__init__.py. When you have generated the files, you will see a change in the init file. This should never be committed when developing flopy. The file must remain empty.Why?
With this functionality in place, we can release flopy independently from modflow6. Meaning that we can push bug fixes to flopy without releasing modflow6, and vice versa.
And we will now be backwards compatible. Flopy can generate python classes from older modflow6 releases.