Create a Getting Started with TopoToolbox guide #102
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
The tutorial directory now contains a series of notebooks modeled on MATLAB's "Getting Started with TopoToolbox" guide. tutorial/tutorial.ipynb serves as the root of this toctree, with the links to the next chapters in the tutorial at the bottom. tutorial/grid.ipynb, tutorial/flow.ipynb, and tutorial/stream.ipynb are currently placeholders into which existing documentation can be moved.
This seems like a slightly more robust way to ensure that users download the notebook that they are reading.
This DEM is slightly smaller and better behaved than the Taiwan DEM.
The text has been copied from MATLAB TopoToolbox's "Calculate basic DEM attributes."
The text is copied from MATLAB TopoToolbox's "Hydrological terrain attributes".
This borrows text from MATLAB's "Derive, plot and modify the stream network".
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 set of changes expands the existing Tutorial to include the topics covered in the "Getting Started with TopoToolbox" section of the MATLAB documentation. All of these notebooks are in the
docs/tutorialdirectory, and they form their own subtree of the table of contents. I deleted a few of the existing examples that overlapped with the expanded tutorial.For the most part I copied the text from the MATLAB documentation and ported the code over. Some of the MATLAB docs use functionality that we haven't implemented yet over here, and we should update the tutorial when we do get around to it. I will create an issue to keep track of that.
The plots of the flow accumulation raster and the
StreamObjectare quite hard to read and our visualization code could use some improvements. I will also create issues for those problems.