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

RTC input files support #226

Open
arthurvd opened this issue Apr 8, 2022 · 0 comments · May be fixed by #342
Open

RTC input files support #226

arthurvd opened this issue Apr 8, 2022 · 0 comments · May be fixed by #342
Assignees
Labels
type: feature Brand new functionality

Comments

@arthurvd
Copy link
Member

arthurvd commented Apr 8, 2022

Describe the desired functionality
Model classes to parse, represent and serialize RTC input files.
See RTC input documentation on: https://content.oss.deltares.nl/delft3d/manuals/D-Real_Time_Control_User_Manual.pdf#appendix.C
Since RTC input is so extensive, the hope is that we can auto-generate these Pydantic classes based on the XSD files. See the preparatory investigation for this in issue #141.

Functional requirements

  • input path is a directory/path, no filename.
  • All input files should be autodetected if they are present in that input path, based on the filenames below.
  • support for toplevel input files
    • rtcDataConfig.xml Time series definitions, interface definitions for file io,
    • rtcParameterConfig.xml Externalized parameters for modification in external
    • rtcRuntimeConfig.xml Definition of runtime relevant info: time step size,
    • rtcToolsConfig.xml

Future ideas
Not yet under this issue: the above will produce pretty technical classes that relate directly to the RTX xmls file elements. In the future a "convenience layer" could be defined on top of this, offering API functions for defining particular kinds of controllers, and all the file-elements being automatically created then.

@arthurvd arthurvd added the type: feature Brand new functionality label Apr 8, 2022
RuudHurkmans added a commit that referenced this issue Sep 23, 2022
File structure as discussed. factory.py is a placeholder for convenience functions (.e.g. make_TimeController()))

Ref: #226
priscavdsluis added a commit that referenced this issue Sep 23, 2022
priscavdsluis added a commit that referenced this issue Sep 26, 2022
…uld still be refactored to be usable for the other RTC files.
priscavdsluis added a commit that referenced this issue Sep 27, 2022
…l be refactored to be usable for the other RTC files.
priscavdsluis added a commit that referenced this issue Sep 27, 2022
priscavdsluis added a commit that referenced this issue Sep 27, 2022
priscavdsluis added a commit that referenced this issue Sep 27, 2022
priscavdsluis added a commit that referenced this issue Sep 27, 2022
priscavdsluis added a commit that referenced this issue Sep 27, 2022
priscavdsluis added a commit that referenced this issue Sep 27, 2022
priscavdsluis added a commit that referenced this issue Sep 28, 2022
priscavdsluis added a commit that referenced this issue Sep 28, 2022
priscavdsluis added a commit that referenced this issue Sep 28, 2022
@priscavdsluis priscavdsluis linked a pull request Oct 3, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature Brand new functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants