olcf/olcf-user-docs

Initial user docs for Job Step Viewer

jack-morrison opened this issue · 1 comments

At a minimum, this should include:

  • How to use JSV
    • examples for both typical and more advanced jsrun lines
  • Limitations of JSV
    • Only Summit (for now)
    • Compiled with XL toolchain only (for now)
    • Does not support MPMD-mode via ERF
    • OpenMP only supported when OMP_NUM_THREADS set via environment variable.
  • Note on allocation overhead
  • Email help@olcf.ornl.gov with bug reports or suggestions.
  • How to open URLs in a few different common terminal applications

When using the default Terminal application on Mac OS X, holding Command (⌘) and double-clicking a URL will open it in the default browser.

When using iTerm2, holding Command (⌘) and single-clicking a URL will open it in the default browser.

🚧 As this tool is not yet released, it may be necessary to WIP: this MR.