Docs/359 create jupyter notebook that runs ra2ce based on a extend defined by the user #414
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
-jupyter notebook as the example -the folder structure with the geojson file that is required in static/network folder
2 tasks
Carsopre
requested changes
Apr 10, 2024
There was a problem hiding this comment.
Please check the headers being defined so they have a proper hierarchy. In visual studio code you can verify this with the "Outline" view https://code.visualstudio.com/docs/getstarted/userinterface#_outline-view
# Chapter
## Section
### Subsection
#### ...
Once you have fixed this we can have a look together on how to add the document to the ra2ce documentation and merge into master.
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| " ### Download a Network using a polygon" |
There was a problem hiding this comment.
The first header should just be a # .
Keep in mind that you need to adhere to the title hierarchy so that we can later on add this example into the documentation files (via sphinx)
Suggested change
| " ### Download a Network using a polygon" | |
| " # Download a Network using a polygon" |
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# Set parameters and initalize a RA2CE run" |
There was a problem hiding this comment.
Suggested change
| "# Set parameters and initalize a RA2CE run" | |
| "## Set parameters and initialize a RA2CE run" |
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# Explore the results" |
There was a problem hiding this comment.
Suggested change
| "# Explore the results" | |
| "## Explore the results" |
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# Finally we can save our downloaded network to the RA2CE folder setup" |
There was a problem hiding this comment.
Suggested change
| "# Finally we can save our downloaded network to the RA2CE folder setup" | |
| "## Finally we can save our downloaded network to the RA2CE folder setup" |
…-ra2ce-based-on-a-extend-defined-by-the-user
…on-a-extend-defined-by-the-user' of https://github.com/Deltares/ra2ce into docs/359-create-jupyter-notebook-that-runs-ra2ce-based-on-a-extend-defined-by-the-user
Carsopre
approved these changes
Apr 11, 2024
Carsopre
deleted the
docs/359-create-jupyter-notebook-that-runs-ra2ce-based-on-a-extend-defined-by-the-user
branch
Carsopre
added a commit
that referenced
this pull request
Apr 12, 2024
…ed by the user (#414) * Jupyter Notebook for downloading a network from a polygon - jupyter notebook as the example - the folder structure with the geojson file that is required in static/network folder * doc: updated example for downloading network using a boundary box * docs: updated the headers in the example notebook markdown cells * docs: added jupyter notebook reference to basic_examples * docs: Update headers in markdown cells in the jupyter notebook --------- Co-authored-by: Carles S. Soriano Pérez <carles.sorianoperez@deltares.nl>
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.
Issue addressed
Solves #359
What has been done?
Created an example jupyter notebook where the user can define the extent via a shapely polygon or a geojson file in a local drive and download the road network from OSM.
Checklist
Additional Notes (optional)
Add any additional notes or information that may be helpful.