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

docs(examples): use pooch for data access in tutorials/examples #2392

Merged
merged 20 commits into from
Dec 12, 2024

Conversation

wpbonelli
Copy link
Member

@wpbonelli wpbonelli commented Dec 10, 2024

First step towards #1872. This is ugly, but it makes notebooks runnable (provided exes and python environment) out of the box. Local files will be used if detected, otherwise downloaded, following the pattern in the mf6 example models.

An eventual models API could hide all the details of model access.

Also mention the optional dependencies requirement on the tutorials and examples gallery pages.

  • feat_working_stack_examples.py
  • mf6_output_tutorial01.py
  • mf6_parallel_model_splitting_example.py
  • mf6_sfr_tutorial01.py
  • modpath6_example.py
  • mt3dms_examples.py
  • nwt_option_blocks_tutorial.py
  • plot_array_example.py
  • plot_cross_section_example.py
  • plot_map_view_example.py
  • raster_intersection_example.py
  • modflow_postprocessing_example.py
  • modelgrid_examples.py
  • mfusg_conduit_examples.py
  • mf6_complex_model_example.py
  • mf_load_tutorial.py
  • mf_error_tutorial.py
  • load_swr_binary_data_example.py
  • groundwater2023_watershed_example.py
  • groundwater_paper_uspb_example.py
  • export_vtk_tutorial.py
  • export_tutorial.py
  • array_output_tutorial.py
  • zonebudget_example.py
  • vtk_pathlines_example.py
  • uzf_example.py
  • shapefile_feature_examples.py
  • shapefile_export_example.py
  • sfrpackage_example.py
  • mf6_mnw2_tutorial01.py
  • mt3dms_sft_lkt_uzt_tutorial.py
  • mf6_support_example.py
  • mfusg_freyberg_example.py
  • mt3d-usgs_example.py

Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.9%. Comparing base (bb9824e) to head (5bf2a4d).
Report is 16 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff            @@
##           develop   #2392     +/-   ##
=========================================
+ Coverage     68.4%   75.9%   +7.5%     
=========================================
  Files          294     295      +1     
  Lines        59390   61665   +2275     
=========================================
+ Hits         40652   46857   +6205     
+ Misses       18738   14808   -3930     

see 229 files with indirect coverage changes

@wpbonelli wpbonelli added this to the 3.9 milestone Dec 10, 2024
@wpbonelli wpbonelli added enhancement dependencies Pull requests that update a dependency file documentation labels Dec 10, 2024
@wpbonelli wpbonelli marked this pull request as ready for review December 12, 2024 01:42
@wpbonelli wpbonelli marked this pull request as draft December 12, 2024 02:29
@wpbonelli wpbonelli marked this pull request as ready for review December 12, 2024 13:25
@wpbonelli wpbonelli merged commit 7298cd1 into modflowpy:develop Dec 12, 2024
23 checks passed
@wpbonelli wpbonelli deleted the example-data branch December 12, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant