-
Notifications
You must be signed in to change notification settings - Fork 361
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
Add connectivity diagram to hpc_benchmark
documentation
#2247
Conversation
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 a lot for working on the content!
Spread the word, that this kind of small enhancements/fixes are highly appreciated! We need more of these!
🚀
hpc_benchmark
documentation
@jhnnsnk, I also added you for the content side review. |
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.
Just some minor suggestions from my side. The ones on the SVG file remove the diagonal lines through the "A"s next to the feedback connections, as they are not really explained in this context.
Co-authored-by: Jochen Martin Eppler <jougs@gmx.net>
Co-authored-by: Jochen Martin Eppler <jougs@gmx.net>
Co-authored-by: Jochen Martin Eppler <jougs@gmx.net>
hpc_benchmark
documentationhpc_benchmark
documentation
During the review phase of a manuscript we realized that it might be beneficial to have figures of the most important models as part of the user level documentation. This PR graphically extends the user level documentation of the
hpc_benchmark.py
file with a detailed figure of its connectivity. The figure and its description are taken (and slightly adapted) from Senk et al (2021).During integration of the figure we realized that the copying and linking of figures requires long relative paths, this can be addressed by a future PR, @terhorstd.
I suggest @jhnnsnk as a reviewer.