Docs docstrings #419
Merged
Docs docstrings #419
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
Update docstrings for HeadObservation, ModflowHobs, and ModflowFlwob classes.
Update docstrings fpr sphinx.
# Conflicts: # flopy/modflow/mfhob.py # flopy/version.py
jdhughes-usgs
pushed a commit
that referenced
this pull request
Oct 18, 2018
#414) * update(ModflowFlwob and ModflowHob): added "no_print", "options", and "filenames" kwargs. * refactor(modpath): refactor MODPATH 7 particle classes Refactor MODPATH 7 particle classes to make a clear distinction between particle groups and particle data (locations, etc.). * Changes to LKT for dealing with multi-species simulations that include lakes (#412) * Explicit cast to np.array isn't preserved * Fixes issue in LAK package _init_ routines when only a single lake is active * Previous alteration worked for one lake, but didn't handle one stage for multiple lakes. This should account for that condition * Fix mis-statement * LMT: Lacking support for keyword 'ALL' following Package_Flows keyword * Add precision for variable thkmin * PERLEN variable getting trucated by use of "G" (general form) when number of significant digits was > 4. * Switching printing of PERLEN in BTN from 10.6G to 10G * Fix for issue #402 including a new test for checking mtlkt.py * Remove apostrophe from comment (interferes with Travis build) * Rename test, another recent commit had the same name * Remove argument from call to test * refactor(modpath): refactor particledata (#416) Refactor ParticleData (input style 1) so that it is the same as the node template (input style 3). Refactor NodeParticleTemplates particles into a single class. Add starting particle location data input style 2. * New jupyter notebook for MT3D-USGS (#415) * Explicit cast to np.array isn't preserved * Fixes issue in LAK package _init_ routines when only a single lake is active * Previous alteration worked for one lake, but didn't handle one stage for multiple lakes. This should account for that condition * Fix mis-statement * LMT: Lacking support for keyword 'ALL' following Package_Flows keyword * Add precision for variable thkmin * PERLEN variable getting trucated by use of "G" (general form) when number of significant digits was > 4. * Switching printing of PERLEN in BTN from 10.6G to 10G * Fix for issue #402 including a new test for checking mtlkt.py * Remove apostrophe from comment (interferes with Travis build) * Rename test, another recent commit had the same name * Remove argument from call to test * Adding new example notebook for MT3D-USGS that uses SFT, LKT, and UZT, including connections between them * Fixed a typo, added link for docs/notebook_examples.md in a reasonable section of the document * An errant capital letter in the new notebook, switched to lowercase * docs: update documentation (#417) Update docstrings for MFGridFile class. Update README.md and CONTRIBUTING.md. Update pre-commit.py to use develop branch for branches with "-" or ":" in the branch name (it is assumed these are bug fix or feature branches for the develop branch. * refactor(lgrutil.py) : redesign of the hidden lgrutil gem Unfortunately, this breaks backward compatibility (if anyone was using this). But the new implementation should be a little easier to use. Still need to implement ghost nodes. * Removed old newline character before "NOPRINT". * docs: update docstrings (#418) Update docstrings for HeadObservation, ModflowHobs, and ModflowFlwob classes. Closed #406 * docs: update docstrings (#419) Update docstrings for sphinx. * refactor(Modflow): Forgive loading models with an incomplete BAS6 package (#420) * raise IOError if external file does not exist * remove requirement that BAS6 needs to be loaded in full * update(ModflowFlwob and ModflowHob): add condition test to check for user-specified output file names. * update(ModflowFlwob and ModflowHob): reworked additional code again after refactorization of upstream branch. * update(ModflowFlwob and ModflowHob): reordered kwargs in __init__ to reflect order in docstring. * update(ModflowFlwob and ModflowHob): reworked additional code again after refactorization of upstream branch. * update(ModflowFlwob and ModflowHob): pass list of filenames to Package.__init__() to achieve desired output file names. * update(ModflowFlwob and ModflowHob): updated HOB test and added new code to test FLWOBS. * update(ModflowFlwob and ModflowHob): pass mf executable name to new model upon load.
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.
No description provided.