#246 Markdown updated to notebook and introduction to tutorials is ad…

…ded.
Deltares · Jun 20, 2022 · 2da747a · 2da747a
1 parent b345f02
commit 2da747a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 12 deletions.
diff --git a/docs/tutorials/first_steps.ipynb → docs/tutorials/build_basic_model.ipynb b/docs/tutorials/first_steps.ipynb → docs/tutorials/build_basic_model.ipynb
@@ -4,25 +4,16 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# First steps\n",
+    "# Build a basic model\n",
     "\n",
-    "This _first steps_ tutorial illustrates how to create a simple D-Flow FM model from scratch using the [HYDROLIB-core](https://github.com/Deltares/HYDROLIB-core). "
+    "This _Build a basic model_ tutorial illustrates how to build a simple D-Flow FM model from scratch using the [HYDROLIB-core](https://github.com/Deltares/HYDROLIB-core). "
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/workspaces/hydrolib-core/hydrolib/core/io/structure/models.py:221: SyntaxWarning: \"is\" with a literal. Did you mean \"==\"?\n",
-      "  if self.type is \"compound\":\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# Import HYDROLIB-core functionalities and setup D-Flow FM model\n",
     "from hydrolib.core.io.structure.models import FlowDirection, StructureModel, Weir\n",

diff --git a/docs/tutorials/tutorials.md b/docs/tutorials/tutorials.md
@@ -0,0 +1,10 @@
+# Introduction to tutorials
+
+Several (iPython notebook) tutorials have been prepared for HYDROLIB-core:
+
+* Tutorial: [Build a basic model](build_basic_model.ipynb) - iPython notebook
+* Tutorial: [Loading and saving a model](loading_and_saving_a_model.md) 
+* Tutorial: [Dataframe handling](dataframe_handling.md)
+* Tutorial: [Plotting a network](plotting_a_network.md)
+
+To run these examples on your local machine you need a copy of the repository and an installation of HYDROLIB-core including some additional packages. The installation of HYDROLIB-core is explained in [Installation](../guides/setup.md).