Examples / RTFD update #69
Merged
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
MuellerSeb
added
enhancement
|
You can have a look at the resulting documentation here: |
MuellerSeb
commented
Jan 27, 2020
LSchueler
reviewed
Jan 27, 2020
There was a problem hiding this comment.
Great stuff!
Just a few minor things:
In the plot from the CovModel additional parameters example, the orange curve looks a bit jaggy, maybe the standard resolution of the CovModel curves could be increased a bit.
What about the namespace of the MasterRNG? - But this might be the topic of another PR.
| @@ -46,6 +46,7 @@ | |||
|
|
|||
|
|
|||
| from gstools.random import MasterRNG | |||
| @@ -7,30 +7,25 @@ | |||
| then create a random field at those coordinates. | |||
| """ | |||
| import numpy as np | |||
| import matplotlib.pyplot as pt | |||
| from gstools import SRF, Exponential | |||
| from gstools.random import MasterRNG | |||
There was a problem hiding this comment.
Should MasterRNG actually be in the gstools namespace? - Not so much going on in gstools.random and MasterRNG is self-explanatory enough to not confuse people.
| pt.axes().set_aspect('equal') | ||
| pt.show() | ||
| ax.tricontourf(x2, y2, field2.T) | ||
| ax.set_aspect("equal") | ||
|
|
LSchueler
approved these changes
Jan 27, 2020
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.
With this PR the following stuff is proposed:
import gstools as gseverywherecormethod is now automatically added to every cov-model__init__.py, solving Routines missing in documentation #47Question
Should we use the autosummary elsewhere in the documentation?