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

HOTI Workshop Tutorials and Doc Updates #32

Open
wants to merge 16 commits into
base: develop
Choose a base branch
from

Conversation

nightlark
Copy link
Contributor

@nightlark nightlark commented Jul 10, 2019

Some open issues with the tutorials from the HOTI slides (22-39, 43-53):

  • The network models section seems to be from the CODES wiki, so I included a link at the start of the wiki; which of the images from the presentation (if any) should be included? In general the text heavy ones wouldn't work well as images so I converted them into text with descriptions, but there might be some diagrams that should be included. Large images with text will be hard to read when they get scaled to fit in the RTD website theme, but some of the less dense diagrams showing network layouts could work. Ideally images will only need to get added once and never changed, because git commits changing binary files can quickly make the repository take up more space (commits "removing" images won't reduce the size, without scrubbing it from the git history) .
  • The HOTI slides link is to the one on the HOTI website (the powerpoint is large enough that I don't want to add it to the repository) -- is there a better mirror of the file that should be used?
  • I've seen some other projects use a GitHub issue or the GitHub wiki for uploading files that are included in their project README -- maybe something similar could be done for the slides linked to on ReadTheDocs

Changes:

  • Created tutorials/guides based on HOTI presentation slides on steps to making a simulation and network model configurations, and workflow based on UserWriteUp.txt
  • Removed remaining instruction docs
  • Split some of the user guide sections into separate files so they can be easily included in other guides/tutorials without adding more places that will need updating if things change
  • Added WallTime macro to the loop body of the Score-P code example
  • Misc formatting changes
  • Update links to moved CODES repository
  • Update links to moved Charm++ documentation
  • Added a placeholder for the Score-P patch

RTD build with changes: https://tracer-ryan-test.readthedocs.io/en/docs-tutorial

docs/tutorial/workflow.rst Outdated Show resolved Hide resolved
docs/userguide.rst Show resolved Hide resolved
@bhatele bhatele changed the base branch from master to develop November 19, 2020 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant