add a first draft of D6 - filedicts design#1448
add a first draft of D6 - filedicts design#1448mandresm wants to merge 2 commits intosprint/filedicts/mainfrom
Conversation
pgierz
left a comment
pgierz
left a comment
There was a problem hiding this comment.
Looks great. I have some specific comments in some of the sections that may be worth a more detailed discussion.
Overall, fantastic design document. I feel much more prepared in building this well after we have settled on everything :)
| ## Retrocompatibility | ||
|
|
||
| The new syntax will substitute to the old syntax. The old syntax won't be supported anymore from the new release version. That means that old runscripts referencing the old file lists will have to be changed to work with the new version containing this refactoring. Same goes for the configs, however, the configs' syntax will be changed to the new one as part of this release, and include test runs with esm_tests. Resuming or branching off old simulations will still be possible because the file structure in `exp` won't change. | ||
|
|
||
| The users will be informed of such changes. |
There was a problem hiding this comment.
👍🏻 (actually +100)
If we spent any effort on making this backward compatible, I would vote that it will be in automatically translating and gently telling the user "Hey, I have updated all of your configs" via <translation tool>.
maintaining two syntaxes when the old one is supposed to be replaced sounds like a bad time.
|
|
||
| Taken from https://github.com/orgs/esm-tools/projects/12/views/1?pane=issue&itemId=8002017 | ||
|
|
||
| - One task, one function |
| Taken from https://github.com/orgs/esm-tools/projects/12/views/1?pane=issue&itemId=8002017 | ||
|
|
||
| - One task, one function | ||
| - Do not change the YAML syntax excessively |
|
|
||
| - One task, one function | ||
| - Do not change the YAML syntax excessively | ||
| - Runscripts and config files need minimal changes |
There was a problem hiding this comment.
not sure I agree with this one. By nature, some of these changes will "look bloated". they aren't, they are making it more precise.
| - One task, one function | ||
| - Do not change the YAML syntax excessively | ||
| - Runscripts and config files need minimal changes | ||
| - Changes should make configs easier to write and understand |
2 participants
This PR includes a draft for D6 - filedicts design. I have copy/pasted the markdown in the description of issue #1419
@pgierz, please go ahead and review it. Even if I used claude-code to produce it I have put a lot of though into it and revised the old Filedicts project to don't re-think the design from scratch (reuse as much as possible from that project). So hopefully you don't find that the document is LLM-garbage :)