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.

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

Add new functionalities to list of supported functionalities #466

Closed
arthurvd opened this issue Mar 13, 2023 · 5 comments · Fixed by #479
Closed

Add new functionalities to list of supported functionalities #466

arthurvd opened this issue Mar 13, 2023 · 5 comments · Fixed by #479
Assignees
Milestone

Comments

@arthurvd
Copy link
Member

arthurvd commented Mar 13, 2023

What is the need for this task.
Our documentation website contains a list of supported functionalities, on:
https://deltares.github.io/HYDROLIB-core/latest/topics/dhydro_support/

The first upcoming release will contain some new functionalities, so this list must be made consistent with these.

What is the task?
Task1:
Some recently added new functionalities should be added to the list, specifically (but only after checking that the underlying issues have been closed as Done):

Task 2:
The apidocs links are wrong since the latest package restructuring.
For example, Bridge now has a dead link to [Bridge][hydrolib.core.io.structure.models.Bridge], this should be [Bridge][hydrolib.core.dflowfm.structure.Bridge]. This probably holds for all class links.

Additional context
The list is maintained via docs\topics\dhydro_support_hydrolib-core.xlsx, only edit the "Source table" tab.

@arthurvd arthurvd added the chore label Mar 13, 2023
@arthurvd arthurvd added this to the Release 0.5 milestone Mar 13, 2023
@arthurvd arthurvd added this to To do in HYDROLIB-core via automation Mar 13, 2023
@tim-vd-aardweg tim-vd-aardweg moved this from To do to In progress in HYDROLIB-core Mar 20, 2023
@tim-vd-aardweg tim-vd-aardweg self-assigned this Mar 20, 2023
@tim-vd-aardweg
Copy link
Contributor

tim-vd-aardweg commented Mar 24, 2023

Done:

  • Updated the namespaces.
  • Refactored the sheet so that it should no longer miss any data from the master sheet.
  • Updated the ExtModel section and subsections.
  • Added an entry for Observation crosssection file (.pli).
  • Added an entry for Observation station file (.xyn).
  • Added a placeholder entry for the .tim files.
  • Added a placeholder entry for the External forcings file (old).

To do:

@priscavdsluis priscavdsluis removed the FLAG label Apr 7, 2023
@tim-vd-aardweg tim-vd-aardweg moved this from In progress to Ready to review in HYDROLIB-core Apr 7, 2023
@MRVermeulenDeltares MRVermeulenDeltares moved this from Ready to review to Review in progress in HYDROLIB-core Apr 7, 2023
@MRVermeulenDeltares MRVermeulenDeltares self-assigned this Apr 7, 2023
@MRVermeulenDeltares
Copy link
Contributor

MRVermeulenDeltares commented Apr 7, 2023

walked through the list after mkdocs serve with the branch and notice the following:

DIMR

  • dimr_config.xml under functionality is differntly shown compared to other components

FM

  • Network file _net.nc under functionality is differntly shown compared to other components
  • Structure file under functionality is bold
  • StructureModel linked to Structure file is this correct?
  • is the "* indicates a scheduled release that is not out yet." still valid for structures?
  • External forcings file empty, is this correct?
  • External forcings file (old) missing, as expected since it is not yet in main. (Support for old ext file #369)
  • Meteo missing, as expected since it is not yet in main.
  • Cross section files only got supported shown.
  • Spatial data files empty
  • output empty
  • Observation station file (.xyn) missing, as expected since it is not yet in main. (Add support for 'old' obs.xyn files (observationpoints) #459)
  • Observation crosssection file (.ini) missing. (Add support for 'old' crs.pli files (observation cross sections) #364 + Include ObservationCrossSectionModel in MDU's Output model #461)
  • History file _his.nc under functionality is differntly shown compared to other components
  • Map file (UGRID) _map.nc under functionality is differntly shown compared to other components
  • Fourier output file _fou.nc under functionality is differntly shown compared to other components

RR

  • Topology layer empty

link for others in list were working

@MRVermeulenDeltares
Copy link
Contributor

MRVermeulenDeltares commented Apr 7, 2023

Observation crosssection file (.ini) seems to be missing because the location is not referenced in any md file.
(#364 + #461 )

hydrolib.core.dflowfm.obscrosssection.models.ObservationCrossSectionModel is expected to be refernced in a md file as followed:

::: hydrolib.core.dflowfm.obscrosssection.models

@MRVermeulenDeltares MRVermeulenDeltares moved this from Review in progress to Reviewer follow up in HYDROLIB-core Apr 7, 2023
@tim-vd-aardweg
Copy link
Contributor

Created new issue for the points that Marlon brought up: #518

@tim-vd-aardweg tim-vd-aardweg moved this from Reviewer follow up to Ready to review in HYDROLIB-core Apr 7, 2023
@arthurvd arthurvd moved this from Ready to review to Review in progress in HYDROLIB-core Apr 11, 2023
@arthurvd arthurvd added the FLAG label Apr 11, 2023
@arthurvd
Copy link
Member Author

I solved the missing obs refs that @MRVermeulenDeltares discovered:

Observation crosssection file (.ini) seems to be missing because the location is not referenced in any md file.
(#364 + #461 )
Originally posted by @MRVermeulenDeltares in #466 (comment)

It's commit 82867e9

@tim-vd-aardweg tim-vd-aardweg moved this from Review in progress to Ready to merge in HYDROLIB-core Apr 14, 2023
HYDROLIB-core automation moved this from Ready to merge to Done Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
HYDROLIB-core
  
Done
Development

Successfully merging a pull request may close this issue.

4 participants