Skip to content

Commit

Permalink
add a welcome notebook for the landlab lessons
Browse files Browse the repository at this point in the history
  • Loading branch information
mcflugen committed Aug 17, 2023
1 parent 918a99e commit 7ab776c
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 4 deletions.
5 changes: 2 additions & 3 deletions README.ipynb
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"cells": [
{
"attachments": {},
"cell_type": "markdown",
"id": "b56d3d13",
"metadata": {},
Expand All @@ -19,7 +18,7 @@
"[python]: ./lessons/python/index.ipynb\n",
"[git]: ./lessons/git/index.md\n",
"[bmi]: ./lessons/bmi/index.ipynb\n",
"[landlab]: ./lessons/landlab/index.ipynb\n",
"[landlab]: ./lessons/landlab/landlab/00_welcome.ipynb\n",
"[pymt]: ./lessons/pymt/index.ipynb\n",
"[permamodel]: ./lessons/permamodel/index.ipynb\n",
"[best-practices]: ./lessons/best-practices/index.md\n",
Expand Down Expand Up @@ -137,7 +136,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.7"
"version": "3.11.3"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
[python]: ./lessons/python/index.ipynb
[git]: ./lessons/git/index.md
[bmi]: ./lessons/bmi/index.ipynb
[landlab]: ./lessons/landlab/index.ipynb
[landlab]: ./lessons/landlab/landlab/00_welcome.ipynb
[pymt]: ./lessons/pymt/index.ipynb
[permamodel]: ./lessons/permamodel/index.ipynb
[best-practices]: ./lessons/best-practices/index.md
Expand Down
97 changes: 97 additions & 0 deletions lessons/landlab/landlab/00_welcome.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<a href=\"http://landlab.github.io\"><img style=\"float: left\" src=\"https://raw.githubusercontent.com/landlab/tutorials/release/landlab_header.png\"></a>"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Landlab\n",
"\n",
"Landlab is an open-source Python-language package for numerical modeling of Earth surface dynamics.\n",
"It contains:\n",
"\n",
"* A gridding engine which represents the model domain. Regular and irregular grids are supported.\n",
"* A library of process components, each of which represents a physical process (e.g., generation\n",
" of rain, erosion by flowing water). These components have a common interface and can be combined\n",
" based on a user's needs.\n",
"* Utilities that support general numerical methods, file input/output, and visualization.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Introduction to landlab\n",
"\n",
"* [Introduction to *Landlab* grids](01-intro.ipynb)\n",
" * The different types of grids\n",
" * Grid elements: *nodes*\n",
"\n",
"* [Data fields](02-data.ipynb)\n",
" * Attaching data to a *Landlab* grid\n",
" * Reading data into a *Landlab* grid\n",
"\n",
"* [More grid elements](03-links-cells.ipynb)\n",
" * Grid elements: *links*\n",
" * Grid elements: *cells*\n",
" \n",
"* [Numerics](04-numerics.ipynb)\n",
" * Calculations on a grid elements\n",
" * Example: Fault scarp\n",
"\n",
"\n",
"## More examples\n",
" \n",
"* [Landlab as a solver for advection-diffusion problems](practice-your-skills.ipynb)\n",
"* [HyLands demo](bedrock_landslides_on_dems.ipynb)\n",
"* [Overland flow](overland_flow.ipynb)\n",
" * This notebook illustrates running the deAlmeida overland flow component in an extremely\n",
" simple-minded way on a real topography, then shows it creating a flood sequence along\n",
" an inclined surface with an oscillating water surface at one end.\n",
"\n",
"**For more Landlab tutorials, click here:** <a href=\"https://landlab.readthedocs.io/en/latest/user_guide/tutorials.html\">https://landlab.readthedocs.io/en/latest/user_guide/tutorials.html</a></small>\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Links\n",
"\n",
"* Reference\n",
" * [Documentation](https://landlab.readthedocs.io)\n",
" * [Source code](https://github.com/landlab/landlab)\n",
"* Ask for help\n",
" * [Issues on GitHub](https://github.com/csdms/landlab/issues)\n",
" * [CSDMS Help Desk](https://csdms.github.io/help-desk)"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Ivy",
"language": "python",
"name": "ivy"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.3"
}
},
"nbformat": 4,
"nbformat_minor": 4
}

0 comments on commit 7ab776c

Please sign in to comment.