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

refactor: self-contained example scripts #137

Merged
merged 47 commits into from
Jan 21, 2024

Conversation

wpbonelli
Copy link
Contributor

@wpbonelli wpbonelli commented Jan 9, 2024

  • intermediate step toward Self-contained example notebooks modflow6#1348
  • remove common/ directory
    • move modeling utilities from common/ to the scripts they're used in
      • todo: de-duplicate Wexler3D solution and curvilinear grid builder, move to flopy or devtools?
    • remove latex utilities from common/, import from modflow-devtools
    • remove plot styles from common/, use flopy.plot.styles
    • remove config module dependency, use environment variables and pytest CLI flags to control behaviors (details in DEVELOPER.md)
  • download and cache data files behind the scenes with https://www.fatiando.org/pooch/latest/retrieve.html — makes cloning project or manually downloading files unnecessary
  • depend on devtools develop branch
  • test in CI with python3.12
  • black/isort formatting
  • fix plot arrangements (legend placement, etc)
  • consistent naming for functions/variables (build_models(), run_models(), scenario(), etc)
  • standardize tag for autogenerating tables from variable assignments: "Model parameters"

@wpbonelli wpbonelli changed the title refactor: move single-use utils from common/ to example scripts refactor: self-contained example scripts Jan 10, 2024
@wpbonelli wpbonelli marked this pull request as ready for review January 21, 2024 18:09
@wpbonelli wpbonelli merged commit 86f7cb5 into MODFLOW-USGS:develop Jan 21, 2024
8 checks passed
@wpbonelli wpbonelli deleted the common branch January 21, 2024 18:15
wpbonelli added a commit to modflowpy/flopy that referenced this pull request Jul 10, 2024
Small step towards #1872. Move geometry info to a YAML file under examples/data/ and move utils into scripts to remove common/ module import and sys.path manipulation. A later PR may introduce pooch as we have done for the mf6 examples:

- MODFLOW-USGS/modflow6-examples#137
- MODFLOW-USGS/modflow6-examples#153
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant