Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update "First steps" tutorial to notebook #246

Closed
rhutten opened this issue Jun 15, 2022 · 1 comment
Closed

Update "First steps" tutorial to notebook #246

rhutten opened this issue Jun 15, 2022 · 1 comment
Assignees
@arthurvd
Labels
type: documentation Improvements or additions to documentation
Projects
HYDROLIB-core
Milestone
0.3.1

Comments

@rhutten
Copy link
Collaborator

rhutten commented Jun 15, 2022 •
edited
Loading

What is the need for this task.
The HYDROLIB team strives to create notebooks as tutorial that can be launched in binder

What is the task?

  • improve first steps tutorial: some steps are missing such as the creation of branch, calculation grid and adding of a profile.
  • create notebook
  • include binder option to documentation

Additional context
Add any other context or screenshots about the feature request here.
@rhutten rhutten added the type: documentation Improvements or additions to documentation label Jun 15, 2022
@rhutten rhutten self-assigned this Jun 15, 2022
@rhutten rhutten added this to To do in HYDROLIB-core via automation Jun 15, 2022
@rhutten rhutten moved this from To do to In progress in HYDROLIB-core Jun 16, 2022
@rhutten rhutten changed the title Update "First steps" tutorial to notebook and binder Update "First steps" tutorial to notebook Jun 16, 2022
rhutten added a commit that referenced this issue Jun 17, 2022
@rhutten
#246 Markdown file 'first steps' is converted to Jupyter notebook
b149750
rhutten added a commit that referenced this issue Jun 20, 2022
@rhutten
#246 Python packages are added to generate documentation from Jupyter…
b345f02 
… Notebooks in developer mode.
rhutten added a commit that referenced this issue Jun 20, 2022
@rhutten
#246 Markdown updated to notebook and introduction to tutorials is ad…
2da747a 
…ded.
rhutten added a commit that referenced this issue Jun 20, 2022
@rhutten
#246 Warning regarding compound structures is solved when running pytest
fa4880c
rhutten added a commit that referenced this issue Jun 20, 2022
@rhutten
#246 update of documentation lay-out
a8630cf
@rhutten rhutten moved this from In progress to Ready to review in HYDROLIB-core Jun 20, 2022
@rhutten rhutten assigned arthurvd and unassigned arthurvd and rhutten Jun 20, 2022
rhutten added a commit that referenced this issue Jun 20, 2022
@rhutten
#246 review implemented
0db7b93
arthurvd added a commit that referenced this issue Jun 20, 2022
@rhutten @arthurvd
Docs/246 update first steps tutorial notebook (#254)
aa4dd9a 
* #246 Markdown file 'first steps' is converted to Jupyter notebook

* #246 Python packages are added to generate documentation from Jupyter Notebooks in developer mode.

* #246 Markdown updated to notebook and introduction to tutorials is added.

* #246 Warning regarding compound structures is solved when running pytest

* #246 update of documentation lay-out

* Update tutorials.md

* #246 review implemented

Co-authored-by: Arthur van Dam <arthurvd@gmail.com>
arthurvd added a commit that referenced this issue Jul 6, 2022
@arthurvd
Squashed commit of the following:
43db2a3 
commit c2a058d
Merge: d94014c c206fc4
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jul 6 15:15:43 2022 +0200

    Merge branch 'feat/242_lateraldischarge_forcingmodel'

commit c206fc4
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jul 6 15:13:09 2022 +0200

    Fix lateral tests

    were failing due to improved checking for realtime/float/filename

commit d94014c
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jul 6 14:56:30 2022 +0200

    feat: support .bc files and more in lateral discharge (#244)

    * feat: support .bc files and more in lateral discharge

    Truly distinguish between a scalar float constant, keyword "realtime" and a .bc file.

    * fix invalid filename in unit test

    (now failed due to improved value parsing of previous commit)

    * Move ForcingData and RealTime to .bc

    such that they can be reused later in structure

commit 959007e
Author: Maarten Pronk <git@evetion.nl>
Date:   Wed Jul 6 14:53:21 2022 +0200

    Removed sonarcloud and reset caches for docs.

commit b9b1c06
Author: Maarten Pronk <evetion@users.noreply.github.com>
Date:   Wed Jul 6 14:03:53 2022 +0200

    Upgrade poetry and cache versions to reset caches. (#267)

commit ed896f9
Author: Prisca van der Sluis <36264671+priscavdsluis@users.noreply.github.com>
Date:   Tue Jul 5 08:30:23 2022 +0200

    fix: allow empty file paths in the .fnm file

    issue: #82 #260

commit 087e0e0
Author: Maarten Pronk <git@evetion.nl>
Date:   Mon Jul 4 15:08:10 2022 +0200

    Updated package description.

commit 240def0
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 18:07:37 2022 +0200

    Move ForcingData and RealTime to .bc

    such that they can be reused later in structure

commit 46f2955
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 17:43:59 2022 +0200

    fix: Add modeltype 21 to RR node for open water precipitation/evaporation (#261)

    * Add modeltype 21 to RR node for open water preciptation/evaporation

    * Document RR mt nodetypes inline

    Co-authored-by: Prisca van der Sluis <36264671+priscavdsluis@users.noreply.github.com>

commit 5134129
Merge: 8ac6bae 6798df9
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 15:10:05 2022 +0200

    Merge branch 'main' into feat/242_lateraldischarge_forcingmodel

commit 6798df9
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 10:00:22 2022 +0200

    168: fix the not-yet-fixed rr docs

commit 8957b9f
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 08:56:43 2022 +0200

    168: Fix rr reference docs for new package structure

commit 3586d6a
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Mon Jun 27 21:55:32 2022 +0200

    feat: add support for observation point ini file (#236)

    * feat: add support for observation point ini file

    code + tests + docs

    * #160: add forgotten test data file for obspoints

    * Generalize Lateral's location validator into util.

    Such that Observation can also use it (and later others as well)

    * Fix minor typo in TestLateral

commit 024f58c
Author: Maarten Tegelaers <BeardedPlatypus@users.noreply.github.com>
Date:   Mon Jun 27 16:34:47 2022 +0200

    fix(filemodel): ResolveRelativeMode is incorrectly set when reading a model with 'pathsRelativeToParent' set to false (#259)

    * Add separate relative mode deduction when reading a model

    * Add additional documentation to FileModel init

    * Fix typo in comment

    * Add additional information detailing the data param

    * autoformat: isort & black

    * Docstring link in documentation only.

    Co-authored-by: Arthur van Dam <arthurvd@gmail.com>

commit cd83c7c
Author: Prisca van der Sluis <36264671+priscavdsluis@users.noreply.github.com>
Date:   Mon Jun 27 15:03:18 2022 +0200

    #229: Add modeldata and geometry subdirectories (#257)

    chore: prepare hydrolib.core.modeldata and hydrolib.core.geometry subpackages (no functionality yet).

commit cb1e53b
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Mon Jun 27 10:47:38 2022 +0200

    refactor(rr)!: place all RR-related code+tests in own rr subpackage (#235)

    * renamed most "bui" dirs/package names to "rr.meteo"
    * fnm/ toplevels files moved to rr/ (no separate subdir for fnm, open for discussion)

commit 4e005bd
Author: Maarten Tegelaers <BeardedPlatypus@users.noreply.github.com>
Date:   Mon Jun 20 18:13:36 2022 +0200

    chore(devcontainer): fix docker devcontainer behaviour (#231)

    * add --no-interaction and --no-ansi flags to poetry install

    * replace extension test adapter with default adapter

    * Update the poetry logic in the docker container

    * Update the documentation of the devcontainer

commit aa4dd9a
Author: rhutten <55204099+rhutten@users.noreply.github.com>
Date:   Mon Jun 20 14:00:07 2022 +0200

    Docs/246 update first steps tutorial notebook (#254)

    * #246 Markdown file 'first steps' is converted to Jupyter notebook

    * #246 Python packages are added to generate documentation from Jupyter Notebooks in developer mode.

    * #246 Markdown updated to notebook and introduction to tutorials is added.

    * #246 Warning regarding compound structures is solved when running pytest

    * #246 update of documentation lay-out

    * Update tutorials.md

    * #246 review implemented

    Co-authored-by: Arthur van Dam <arthurvd@gmail.com>

commit 7c00946
Author: Maarten Pronk <git@evetion.nl>
Date:   Fri Jun 3 11:17:35 2022 +0200

    Forbid fault mkdocs-autorefs version.

commit 7e211ec
Author: Maarten Pronk <git@evetion.nl>
Date:   Fri Jun 3 11:03:46 2022 +0200

    Downgrade markupsafe.

commit 3211f37
Author: Maarten Pronk <git@evetion.nl>
Date:   Fri Jun 3 10:53:52 2022 +0200

    Downgrade jinja2.

commit b5e9da3
Author: Maarten Pronk <evetion@users.noreply.github.com>
Date:   Fri Jun 3 10:46:16 2022 +0200

    Updated hydrolib-core dependencies to easy combined installation with other packages. (#245)

commit 8ac6bae
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Fri Jun 3 08:09:50 2022 +0200

    fix invalid filename in unit test

    (now failed due to improved value parsing of previous commit)

commit d9d3fb1
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Fri Jun 3 08:05:05 2022 +0200

    feat: support .bc files and more in lateral discharge

    Truly distinguish between a scalar float constant, keyword "realtime" and a .bc file.

commit 2197a1e
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jun 1 17:38:52 2022 +0200

    doc: extend docstrings of almost all .bc classes

commit 0e156c7
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jun 1 17:34:49 2022 +0200

    docs: fix some docstring typos

commit a5ece8b
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Thu May 19 14:22:18 2022 +0200

    refactor: remove dead code of _process_edges_for_branch

    (which contained a bug as well)

commit 24dc275
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Thu May 19 13:57:31 2022 +0200

    Fix copyright year to 2022.

commit 1657e9d
Author: grongen <guusrongen@gmail.com>
Date:   Thu May 19 11:26:34 2022 +0200

    Bug/233 error short connecting branch (#234)

    * Add extra node coordinate to branch

    Add extra node coordinate to branch as well, when the initial branch only contains already present coordinates. This solved the indexing error later on.

    * Added test to check if coordinate is added as well

    Added test to check if coordinate is added as well, when adding small connecting branch

commit 2f35795
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Thu Apr 21 15:39:23 2022 +0200

    Add issue template "Task"

commit f47e822
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Thu Apr 21 15:29:06 2022 +0200

    Add issue template "Feature request"
arthurvd added a commit that referenced this issue Jul 6, 2022
@arthurvd
Fix: fnm serializer to only print filepath item of dict values (#224)
09b14bd 
* #224: Fix fnm serializer to only print filepath item of dict values

Otherwise, it would print '{'filepath': WindowsPath('3b_nod.tp'), 'node': []}', now it just prints '3b_nod.tp'.

* Review followup: stricter type check in _get_string_value

* Squashed commit of the following:

commit c2a058d
Merge: d94014c c206fc4
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jul 6 15:15:43 2022 +0200

    Merge branch 'feat/242_lateraldischarge_forcingmodel'

commit c206fc4
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jul 6 15:13:09 2022 +0200

    Fix lateral tests

    were failing due to improved checking for realtime/float/filename

commit d94014c
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jul 6 14:56:30 2022 +0200

    feat: support .bc files and more in lateral discharge (#244)

    * feat: support .bc files and more in lateral discharge

    Truly distinguish between a scalar float constant, keyword "realtime" and a .bc file.

    * fix invalid filename in unit test

    (now failed due to improved value parsing of previous commit)

    * Move ForcingData and RealTime to .bc

    such that they can be reused later in structure

commit 959007e
Author: Maarten Pronk <git@evetion.nl>
Date:   Wed Jul 6 14:53:21 2022 +0200

    Removed sonarcloud and reset caches for docs.

commit b9b1c06
Author: Maarten Pronk <evetion@users.noreply.github.com>
Date:   Wed Jul 6 14:03:53 2022 +0200

    Upgrade poetry and cache versions to reset caches. (#267)

commit ed896f9
Author: Prisca van der Sluis <36264671+priscavdsluis@users.noreply.github.com>
Date:   Tue Jul 5 08:30:23 2022 +0200

    fix: allow empty file paths in the .fnm file

    issue: #82 #260

commit 087e0e0
Author: Maarten Pronk <git@evetion.nl>
Date:   Mon Jul 4 15:08:10 2022 +0200

    Updated package description.

commit 240def0
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 18:07:37 2022 +0200

    Move ForcingData and RealTime to .bc

    such that they can be reused later in structure

commit 46f2955
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 17:43:59 2022 +0200

    fix: Add modeltype 21 to RR node for open water precipitation/evaporation (#261)

    * Add modeltype 21 to RR node for open water preciptation/evaporation

    * Document RR mt nodetypes inline

    Co-authored-by: Prisca van der Sluis <36264671+priscavdsluis@users.noreply.github.com>

commit 5134129
Merge: 8ac6bae 6798df9
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 15:10:05 2022 +0200

    Merge branch 'main' into feat/242_lateraldischarge_forcingmodel

commit 6798df9
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 10:00:22 2022 +0200

    168: fix the not-yet-fixed rr docs

commit 8957b9f
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Tue Jun 28 08:56:43 2022 +0200

    168: Fix rr reference docs for new package structure

commit 3586d6a
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Mon Jun 27 21:55:32 2022 +0200

    feat: add support for observation point ini file (#236)

    * feat: add support for observation point ini file

    code + tests + docs

    * #160: add forgotten test data file for obspoints

    * Generalize Lateral's location validator into util.

    Such that Observation can also use it (and later others as well)

    * Fix minor typo in TestLateral

commit 024f58c
Author: Maarten Tegelaers <BeardedPlatypus@users.noreply.github.com>
Date:   Mon Jun 27 16:34:47 2022 +0200

    fix(filemodel): ResolveRelativeMode is incorrectly set when reading a model with 'pathsRelativeToParent' set to false (#259)

    * Add separate relative mode deduction when reading a model

    * Add additional documentation to FileModel init

    * Fix typo in comment

    * Add additional information detailing the data param

    * autoformat: isort & black

    * Docstring link in documentation only.

    Co-authored-by: Arthur van Dam <arthurvd@gmail.com>

commit cd83c7c
Author: Prisca van der Sluis <36264671+priscavdsluis@users.noreply.github.com>
Date:   Mon Jun 27 15:03:18 2022 +0200

    #229: Add modeldata and geometry subdirectories (#257)

    chore: prepare hydrolib.core.modeldata and hydrolib.core.geometry subpackages (no functionality yet).

commit cb1e53b
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Mon Jun 27 10:47:38 2022 +0200

    refactor(rr)!: place all RR-related code+tests in own rr subpackage (#235)

    * renamed most "bui" dirs/package names to "rr.meteo"
    * fnm/ toplevels files moved to rr/ (no separate subdir for fnm, open for discussion)

commit 4e005bd
Author: Maarten Tegelaers <BeardedPlatypus@users.noreply.github.com>
Date:   Mon Jun 20 18:13:36 2022 +0200

    chore(devcontainer): fix docker devcontainer behaviour (#231)

    * add --no-interaction and --no-ansi flags to poetry install

    * replace extension test adapter with default adapter

    * Update the poetry logic in the docker container

    * Update the documentation of the devcontainer

commit aa4dd9a
Author: rhutten <55204099+rhutten@users.noreply.github.com>
Date:   Mon Jun 20 14:00:07 2022 +0200

    Docs/246 update first steps tutorial notebook (#254)

    * #246 Markdown file 'first steps' is converted to Jupyter notebook

    * #246 Python packages are added to generate documentation from Jupyter Notebooks in developer mode.

    * #246 Markdown updated to notebook and introduction to tutorials is added.

    * #246 Warning regarding compound structures is solved when running pytest

    * #246 update of documentation lay-out

    * Update tutorials.md

    * #246 review implemented

    Co-authored-by: Arthur van Dam <arthurvd@gmail.com>

commit 7c00946
Author: Maarten Pronk <git@evetion.nl>
Date:   Fri Jun 3 11:17:35 2022 +0200

    Forbid fault mkdocs-autorefs version.

commit 7e211ec
Author: Maarten Pronk <git@evetion.nl>
Date:   Fri Jun 3 11:03:46 2022 +0200

    Downgrade markupsafe.

commit 3211f37
Author: Maarten Pronk <git@evetion.nl>
Date:   Fri Jun 3 10:53:52 2022 +0200

    Downgrade jinja2.

commit b5e9da3
Author: Maarten Pronk <evetion@users.noreply.github.com>
Date:   Fri Jun 3 10:46:16 2022 +0200

    Updated hydrolib-core dependencies to easy combined installation with other packages. (#245)

commit 8ac6bae
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Fri Jun 3 08:09:50 2022 +0200

    fix invalid filename in unit test

    (now failed due to improved value parsing of previous commit)

commit d9d3fb1
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Fri Jun 3 08:05:05 2022 +0200

    feat: support .bc files and more in lateral discharge

    Truly distinguish between a scalar float constant, keyword "realtime" and a .bc file.

commit 2197a1e
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jun 1 17:38:52 2022 +0200

    doc: extend docstrings of almost all .bc classes

commit 0e156c7
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Wed Jun 1 17:34:49 2022 +0200

    docs: fix some docstring typos

commit a5ece8b
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Thu May 19 14:22:18 2022 +0200

    refactor: remove dead code of _process_edges_for_branch

    (which contained a bug as well)

commit 24dc275
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Thu May 19 13:57:31 2022 +0200

    Fix copyright year to 2022.

commit 1657e9d
Author: grongen <guusrongen@gmail.com>
Date:   Thu May 19 11:26:34 2022 +0200

    Bug/233 error short connecting branch (#234)

    * Add extra node coordinate to branch

    Add extra node coordinate to branch as well, when the initial branch only contains already present coordinates. This solved the indexing error later on.

    * Added test to check if coordinate is added as well

    Added test to check if coordinate is added as well, when adding small connecting branch

commit 2f35795
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Thu Apr 21 15:39:23 2022 +0200

    Add issue template "Task"

commit f47e822
Author: Arthur van Dam <arthurvd@gmail.com>
Date:   Thu Apr 21 15:29:06 2022 +0200

    Add issue template "Feature request"

* Resolve conflicted changes for models.py in new rr subdir

* Fix the review fix

Accept str in _get_string_value as well, to support filename values that point to non-existent files. Was needed in unit tests, and also possibly in incomplete model input.

* autoformat: isort & black

* Finish conflict resolution: delete io.fnm

* Fix fnm unit tests caused by None strings

* autoformat: isort & black

Co-authored-by: arthurvd <arthurvd@users.noreply.github.com>
@priscavdsluis priscavdsluis added this to the Release 0.4 milestone Jul 14, 2022
arthurvd added a commit that referenced this issue Jul 15, 2022
@arthurvd
#246: fix dead links to "build basic model" tutorial
069a447
@arthurvd arthurvd moved this from Ready to review to Review in progress in HYDROLIB-core Jul 15, 2022
@arthurvd arthurvd mentioned this issue Jul 15, 2022
Open
@arthurvd
Copy link
Member

Notebook ok now. The binder link must be generated automatically and only for the html version of this notebook.
Will close this issue and continue that work under new issue #285.

HYDROLIB-core automation moved this from Review in progress to Done Jul 15, 2022
@priscavdsluis priscavdsluis modified the milestones: Release 0.4, 0.3.1 Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arthurvd arthurvd

Labels
type: documentation Improvements or additions to documentation
Projects
HYDROLIB-core
  
Done
Milestone
0.3.1
Development

No branches or pull requests
3 participants
@arthurvd @priscavdsluis @rhutten