Reading of [sedtrails] section in .mdu

[SCLaan]

Describe the bug
HYDROLIB-core 0.7.0 cannot read the default [sedtrails] section in a .mdu, as written in the copy in the .dia:

[sedtrails]
SedtrailsGrid       =             # Grid file for sedtrails output locations on corners
SedtrailsAnalysis   = all         # Sedtrails analysis. Should be all, transport, flowvelocity or soulsby.
SedtrailsInterval   = 3600. 0. 0. # Sedtrails output times (s), interval, starttime, stoptime (s), if starttime, stoptime are left blank, use whole simulation period
SedtrailsOutputFile =             # Sedtrails time-avgd output file

To Reproduce
Steps to reproduce the behavior:

1. Include the above code in a .mdu
2. Try to read the .mdu

   from pathlib import Path
   import hydrolib.core.dflowfm as hcdfm
   hcdfm.FMModel(filepath=Path(r'P:/path/to/file.mdu'), recurse=False)
   

3. See the error (below)

Expected behavior
This section should be read correctly. Alternatively it could be included in a comments field, as is done for the [veg] section.

Screenshots

ValidationError: 1 validation error for FMModel
mwra_hydro_dia.mdu -> sedtrails
  extra fields not permitted (type=value_error.extra)

Version info (please complete the following information):

• OS: Windows 10
• Version 0.7.0

[MRVermeulenDeltares]

As we understand, the goal for this issue is:

• Implement sedtrails section
• Add sedtrails section to FMModel

@veenstrajelmer & @rhutten is this correct?

[tim-vd-aardweg]

I have asked @hrajagers by email what all the keywords are that are supported for the [sedtrails] section. We should wait with picking up this issue until we have a response.

[tim-vd-aardweg]

I got a very elaborate answer, I will post it here (in Dutch):

. De lijst van keywords lijkt op zich compleet.
D-Flow FM ondersteunt de volgende keywords in het [sedtrails] blok:

SedtrailsGrid
Standaard een lege string. Indien dit een lege string is dan is de sedtrails uitvoer niet actief en worden andere keywords niet gelezen.
Indien niet leeg dan moet dit verwijzen naar een netCDF UGRID file met een 2D rooster.

SedtrailsAnalysis
De waarde moet een van de volgende strings zijn: all, flowvelocity, transport of soulsby.
Indien niet gespecificeerd: all.

SedtrailsInterval
Hier worden drie getallen verwacht: interval, start time, end time.
Het eerste getal (interval) wordt in de code begrensd op getallen groter of gelijk aan dt_user.
De default waarden zijn 3600 0 0

SedtrailsOutputFile
Dit is de naam van de extra netCDF UGRID map uitvoer.
Default wordt deze naam gelijk gesteld aan _sedtrails.nc waarbij de naam is van de mdu-file.

De optie maakt het mogelijk om enkele D-Flow FM grootheden weg te schrijven gemiddeld naar de nodes van het gespecificeerde rooster:
• dieptegemiddelde stroomsnelheden (indien flowvelocity of all)
• bodem en zwevende sediment transporten (indien transport of all)
• waterdiepte, bodemschuifspanning, en niet-lineaire snelheidsbijdrage van golven (indien soulsby of all)
Hoewel deze functionaliteit primair is ontwikkeld voor nabewerking met de Sedtrails tool ten behoeve van het opstellen van sedimentbalansen, weet ik dat andere collega’s ook geïnteresseerd zijn in deze optie omdat grootheden hiermee op een ander (kleiner) rooster kan worden weggeschreven hetgeen een vermindering van de dataopslag zou kunnen geven. Ik zie hiervoor op termijn liever een andere oplossing.