Add connectivity diagram to hpc_benchmark documentation
#2247
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
terhorstd
added
S: Normal
terhorstd
reviewed
Dec 15, 2021
terhorstd
approved these changes
Dec 15, 2021
terhorstd
changed the title
hpc_benchmark documentation
|
@jhnnsnk, I also added you for the content side review. |
jougs
reviewed
Dec 15, 2021
Co-authored-by: Jochen Martin Eppler <jougs@gmx.net>
Co-authored-by: Jochen Martin Eppler <jougs@gmx.net>
jougs
requested changes
Dec 15, 2021
Co-authored-by: Jochen Martin Eppler <jougs@gmx.net>
jougs
approved these changes
Dec 15, 2021
jougs
changed the title
hpc_benchmark documentationhpc_benchmark documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.pyfile 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.