Skip to content

Commit

Permalink
#246 review implemented
Browse files Browse the repository at this point in the history
  • Loading branch information
rhutten committed Jun 20, 2022
1 parent a8630cf commit 0db7b93
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions docs/tutorials/build_basic_model.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# Build a basic model\n",
"\n",
"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). "
"This _Build a basic model_ tutorial illustrates how to build a simple D-Flow FM model from scratch using [HYDROLIB-core](https://github.com/Deltares/HYDROLIB-core). "
]
},
{
Expand Down Expand Up @@ -47,11 +47,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Note that the creation of a `Weir` and other models always require\n",
"the use of keyword arguments. A `ValidationError` will be raised\n",
"when the model isn't correct or complete, for instance, in the case\n",
"that `StructureModel` was assigned directly to `structurefile` instead\n",
"of as a list.\n",
"Note that the creation of a `Weir` and other model objects requires several input arguments.\n",
"A `ValidationError` will be raised when the model is invalid or incomplete.\n",
"For instance, in the above example, if the `StructureModel` had been assigned directly to `structurefile` instead of as a list, that would have triggered a `ValidationError`.\n",
"\n",
"Now let's add this model to a DIMR config and save it."
]
Expand All @@ -77,9 +75,8 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The save on the top of the model hierarchy will result in saves of all child models,\n",
"so this results in four files (`dimr_config.xml`, `network.nc`, `structures.ini`,`test.mdu`)\n",
"in the working directory."
"The save call on the highest-level DIMR object will result in recursive saves of all child models in the model hierarchy, so this results in four files (`dimr_config.xml`, `network.nc`, `structures.ini`,`test.mdu`) in the working directory.\n",
"Some more in-depth background about recursive saving of a model tree is given in another tutorial: [Loading and saving](loading_and_saving_a_model.md)."
]
},
{
Expand Down

0 comments on commit 0db7b93

Please sign in to comment.