-
Notifications
You must be signed in to change notification settings - Fork 63
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
t-route (master branch) docs update #506
Conversation
ab36ce3
to
24633b9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this @mattw-nws! Ive added a few minor edits that im happy to contribute to your branch if you would like me to do that?
doc/PYTHON_ROUTING.md
Outdated
|
||
The t-route extension modules rely on netcdf fortran, and thus they need to be compiled with the same fortran compiler that compiled |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add "Note," to begin this paragraph as it does not affect all installations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've sometimes abused >
for this kind of thing (blockquote), do you happen to know some GHMD-fu for this use-case?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I often bold NOTE at the beginning of the line, but that also not great. Im not aware of a more semantic way. I like you block quote approach though. The appearance is more like a text book or blog post.
|
||
To enable routing in a simulation realization config file, a `routing` block should appear with a path to the t-route configuration file at the same level as the `time` configuration, like so: | ||
|
||
```JSON |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not crucial, but you can use "json5" as the block language type instead of json which enables comment characters. This will fix the formatting of ...
.
// comment
// ...
[1, 2, 3]
// ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Neat... I have sometimes used Javascript
instead but folks complained.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
of course.... ngen's JSON parser doesn't support comments... yet... so that might lead to consternation for some.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a great point. Ill leave it as is!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also my Friday is now instantly better having read the work consternation. Excellent word choice!
Please feel free |
Sorry, @mattw-nws, for whatever reason I didnt get a notification that you'd responded to this PR review. Sorry i've let it go a little dormant! Ill make the changes and push them to your branch now. |
@mattw-nws, just made the changes to your branch. If you are happy with the changes, I think we are good to merge. |
Documentation update to go with #502
Additions
Removals
extern/t-route
, which is no longer recommendedChanges
Testing
Screenshots
Notes
Todos
Checklist
Testing checklist (automated report can be put here)
Target Environment support