Expanded documentation in BMI Python example notebook #175
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
Limit: 79 characters (or 72 characters for docstrings/comments)
with pointers to documentation, additional headers describing code blocks, which I further split for clarity to new comers.
Updated conda environment to PyPI / condaforge v0.0.10, based on phreeqcrm 3.8.0. https://github.com/usgs-coupled/phreeqcrm/releases
aufdenkampe
changed the title
|
Thanks @aufdenkampe and @shannarucker |
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.
This PR adds documentation to your extremely helpful
swig/python/ex11-advect/ex11-advect.ipynbexample notebook with new markdown, comments, and additional outputs. @shannarucker and I were careful to limit our edits to work with your lean condaenvironment.ymlby not adding any extra dependencies and to follow your original workflow. The entire notebook runs in a couple of seconds.These edits helped our team learn and share the impressive capabilities of
PhreeqcRM,BMIPhreeqcRM,YAMLPhreeqcRMfor automating and coupling Phreeqc to external advection models. We imagine that our expanded documentation could help others too.@scharlton2 & @dlparkhurst, thanks for your efforts over the last year to developing a BMI Python wrapper for PHREEQC! Our team expects to leverage these capabilities substantially in the near future on a variety of projects.