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

Support Tim files #348

Closed
priscavdsluis opened this issue Oct 3, 2022 · 4 comments · Fixed by #465
Closed

Support Tim files #348

priscavdsluis opened this issue Oct 3, 2022 · 4 comments · Fixed by #465
Assignees
@priscavdsluis @MRVermeulenDeltares
Labels
type: feature Brand new functionality
Projects
HYDROLIB-core

Comments

@priscavdsluis
Copy link
Contributor

priscavdsluis commented Oct 3, 2022 •
edited by arthurvd
Loading

Is your feature request related to a problem? Please describe.
Even though the new format is .bc files, many models still contain .tim files.

Describe the solution you'd like
Support tim files as time series files.

  • See format description in https://content.oss.deltares.nl/delft3d/D-Flow_FM_User_Manual_1D2D.pdf#section.C.4
  • Support comment lines (starting with Either * or #), and store them as strings, such that they are preserved when saving a .tim file again.
  • Do NOT further parse/interpret comment lines in more detail (e.g., we'll not try to derive a reference date/time from any comment line)
  • Do NOT support comments at the end of regular data lines
  • While printing/saving a tim file: make sure the column values are aligned, by the use of fixed width number formats and fixed whitespace.
  • Both the whitespace and the number format would be nice if it is configurable by the user through a SerializerConfig (see how this was done for Improve bc file formatting #308)
@priscavdsluis priscavdsluis added the type: feature Brand new functionality label Oct 3, 2022
@priscavdsluis priscavdsluis added this to To do in HYDROLIB-core via automation Oct 3, 2022
@priscavdsluis priscavdsluis moved this from To do to In progress in HYDROLIB-core Oct 14, 2022
@priscavdsluis priscavdsluis moved this from In progress to To do in HYDROLIB-core Oct 14, 2022
This was referenced Dec 14, 2022
Closed
Open
@MRVermeulenDeltares MRVermeulenDeltares moved this from To do to In progress in HYDROLIB-core Mar 10, 2023
@MRVermeulenDeltares MRVermeulenDeltares self-assigned this Mar 10, 2023
@MRVermeulenDeltares
Copy link
Contributor

MRVermeulenDeltares commented Mar 10, 2023 •
edited
Loading

example of .tim file:
https://repos.deltares.nl/repos/DSCTestbench/trunk/cases/e02_dflowfm/f005_boundary_conditions/c011_waterlevel_tim_varying/tfl_01_0001.tim

@MRVermeulenDeltares
Copy link
Contributor

https://content.oss.deltares.nl/delft3dfm1d2d/D-Flow_FM_User_Manual_1D2D.pdf#section.C.4

MRVermeulenDeltares added a commit that referenced this issue Mar 13, 2023
@MRVermeulenDeltares
#348 Setup first design of tim file support with tests
8fcc7e1
@MRVermeulenDeltares MRVermeulenDeltares mentioned this issue Mar 13, 2023
Merged
@MRVermeulenDeltares MRVermeulenDeltares linked a pull request Mar 13, 2023 that will close this issue
feat: Support .tim files #465
Merged
MRVermeulenDeltares added a commit that referenced this issue Mar 13, 2023
@MRVermeulenDeltares
#348 try and resolve issue with python 3.8 and TypeError
792e2c9
MRVermeulenDeltares added a commit that referenced this issue Mar 13, 2023
@MRVermeulenDeltares
#348 try and resolve issue with python 3.8 and TypeError with List
d6b54ab
@arthurvd arthurvd mentioned this issue Mar 13, 2023
Closed
MRVermeulenDeltares added a commit that referenced this issue Mar 14, 2023
@MRVermeulenDeltares
#348 resolve codesmell
584da88
@MRVermeulenDeltares
Copy link
Contributor

MRVermeulenDeltares commented Mar 14, 2023 •
edited
Loading

Volgende besproken met @veenstrajelmer:

Iedere tijd is uniek en mag niet meerdere keren voorkomen

  • nalopen hoe dit bij bc files wordt gedaan
  • error bij meerdere keren dezelfde tijd

niet numerieke waardes mogen niet voorkomen buiten comments om

  • nalopen hoe dit bij bc files wordt gedaan
  • consistency nalopen

Moet de gebruiker het schrijven van de timfile op dezelfde manier kunnen configureren als bij bv. het data block van de bcfile?
e.g. whitespaces tussen data, comma delimited, etc..

  • fijn als de colommen onder elkaar staan, dat het uitgelijnd staat
  • precisie hetzelfde als de input, vergelijkbaar als bij de bc file (voor consistency hergebruik van serializerconfig)
  • niet al te veel moeite in stoppen

zowel lezen als schrijven is handig

  • terugleveren van data in lijn met bestaande onderdelen en efficiënt in te lezen

Comments moeten gelezen en geschreven kunnen worden

  • de comments moeten ingelezen worden en ook worden terug gezet als er wordt geschreven

MRVermeulenDeltares added a commit that referenced this issue Mar 14, 2023
@MRVermeulenDeltares
#348 refactor parser
c0a4c00
MRVermeulenDeltares added a commit that referenced this issue Mar 20, 2023
@MRVermeulenDeltares
#348 change to timtimeserie to support parsing comments instead of sk…
4408b15 
…ipping
MRVermeulenDeltares added a commit that referenced this issue Mar 20, 2023
@MRVermeulenDeltares
#348 update tim model and serializer to format files
f754f9e
MRVermeulenDeltares added a commit that referenced this issue Mar 20, 2023
@MRVermeulenDeltares
#348 cleanup code smells
3e4b9e9
MRVermeulenDeltares added a commit that referenced this issue Mar 20, 2023
@MRVermeulenDeltares
#348 refactor model, parser and serializer
fbc860f
MRVermeulenDeltares added a commit that referenced this issue Mar 21, 2023
@MRVermeulenDeltares
#348 refactor codesmell away
1bc386e
MRVermeulenDeltares added a commit that referenced this issue Mar 21, 2023
@MRVermeulenDeltares
#348 resolve codesmell
6964b9b
MRVermeulenDeltares added a commit that referenced this issue Mar 21, 2023
@MRVermeulenDeltares
#348 cleanup and add documentation
413b6c7
@MRVermeulenDeltares MRVermeulenDeltares moved this from In progress to Ready to review in HYDROLIB-core Mar 21, 2023
@priscavdsluis priscavdsluis moved this from Ready to review to Review in progress in HYDROLIB-core Mar 22, 2023
@priscavdsluis priscavdsluis moved this from Review in progress to Reviewer follow up in HYDROLIB-core Mar 22, 2023
@MRVermeulenDeltares MRVermeulenDeltares moved this from Reviewer follow up to In progress in HYDROLIB-core Mar 24, 2023
MRVermeulenDeltares added a commit that referenced this issue Mar 30, 2023
@MRVermeulenDeltares
#348 update init for timmodel
df2dca2
@priscavdsluis priscavdsluis mentioned this issue Mar 30, 2023
Closed
@veenstrajelmer veenstrajelmer mentioned this issue Mar 30, 2023
Closed
@MRVermeulenDeltares MRVermeulenDeltares moved this from In progress to Ready to review in HYDROLIB-core Mar 30, 2023
MRVermeulenDeltares added a commit that referenced this issue Mar 30, 2023
@MRVermeulenDeltares
#348 cleanup and add error thrown test
3fdff20
@priscavdsluis priscavdsluis moved this from Ready to review to Review in progress in HYDROLIB-core Mar 30, 2023
@priscavdsluis priscavdsluis moved this from Review in progress to Reviewer follow up in HYDROLIB-core Mar 31, 2023
@veenstrajelmer veenstrajelmer mentioned this issue Mar 31, 2023
Closed
@MRVermeulenDeltares MRVermeulenDeltares moved this from Reviewer follow up to In progress in HYDROLIB-core Apr 3, 2023
MRVermeulenDeltares added a commit that referenced this issue Apr 4, 2023
@MRVermeulenDeltares
#348 implement suggested parser and adjust tests based on new impleme…
61f8708 
…ntation
MRVermeulenDeltares added a commit that referenced this issue Apr 4, 2023
@MRVermeulenDeltares
#348 refactor parser and update models according to refactor
e94aef4
MRVermeulenDeltares added a commit that referenced this issue Apr 4, 2023
@MRVermeulenDeltares
#348 remove test from parsing level
5beb455
MRVermeulenDeltares added a commit that referenced this issue Apr 4, 2023
@MRVermeulenDeltares
#348 implement suggested serializer and adjust tests based on new imp…
3d63e11 
…lementation
MRVermeulenDeltares added a commit that referenced this issue Apr 4, 2023
@MRVermeulenDeltares
#348 refactor serializer and implement first changes for timmodel, up…
b1e5578 
…date test accordingly
MRVermeulenDeltares added a commit that referenced this issue Apr 4, 2023
@MRVermeulenDeltares
#348 add validator in timmodel, add test for validator and update par…
d77f1cd 
…ser and serializer function return type
MRVermeulenDeltares added a commit that referenced this issue Apr 4, 2023
@MRVermeulenDeltares
#348 add documentation to validator and resolve issue with python 3.8…
dd62853 
… in parser
MRVermeulenDeltares added a commit that referenced this issue Apr 4, 2023
@MRVermeulenDeltares
#348 resolve issue with whitespace offset
a611818
@MRVermeulenDeltares MRVermeulenDeltares moved this from In progress to Ready to review in HYDROLIB-core Apr 4, 2023
@priscavdsluis priscavdsluis moved this from Ready to review to Review in progress in HYDROLIB-core Apr 5, 2023
@priscavdsluis priscavdsluis moved this from Review in progress to Reviewer follow up in HYDROLIB-core Apr 5, 2023
@MRVermeulenDeltares MRVermeulenDeltares moved this from Reviewer follow up to In progress in HYDROLIB-core Apr 5, 2023
@priscavdsluis priscavdsluis mentioned this issue Apr 5, 2023
Closed
MRVermeulenDeltares added a commit that referenced this issue Apr 5, 2023
@MRVermeulenDeltares
#348 update test according to latest suggested change for timmodel wi…
7110c43 
…th error messages
@MRVermeulenDeltares MRVermeulenDeltares moved this from In progress to Ready to review in HYDROLIB-core Apr 5, 2023
priscavdsluis added a commit that referenced this issue Apr 5, 2023
@priscavdsluis
#348: Document class attributes.
a08b1a8
@priscavdsluis priscavdsluis moved this from Ready to review to Ready to merge in HYDROLIB-core Apr 5, 2023
priscavdsluis pushed a commit that referenced this issue Apr 5, 2023
@MRVermeulenDeltares
feat: Support *.tim files
32c3553 
Refs: #348
HYDROLIB-core automation moved this from Ready to merge to Done Apr 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@priscavdsluis priscavdsluis

@MRVermeulenDeltares MRVermeulenDeltares

Labels
type: feature Brand new functionality
Projects
HYDROLIB-core
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Support .tim files Deltares/HYDROLIB-core
2 participants
@priscavdsluis @MRVermeulenDeltares