Identify and migrate relevant "Software Pages" about olcf-user-docs HOT 7 CLOSED

Definitely migrate

• ARM Performance Reports
• ARM Forge
  • DDT
• Vampir
• Visit

May make for good future additions

• Python (because it's a FAQ)
• Darshan (because it's loaded automatically via DefApps on Summit)
• Globus (because this is the recommended data transfer tool)
• IBM WML (ADW?)
• LAMMPS
• NAMD

from olcf-user-docs.

just a note that needs a home:

there are references to compilers in the Rhea user-guide's "compiling" section that will need to be updated.

from olcf-user-docs.

@grahamlopez is that in the scope of this issue?

from olcf-user-docs.

I am talking about the links to e.g. the intel compilers, which seem to point to the old software page. Depending on how the software page gets redone, these kinds of links will either need to go away, or be updated, or ...

from olcf-user-docs.

Make the Summit User Guide 'Software' section wider in scope to include:

• Software
  • OLCF software strategy. What's provided, what's not, and why? (not a list of packages)
  • Compiling
    • Available Compilers
    • Linking in libraries
  • Building Scientific Applications
    (OLCF-Tutorials GitHub Org. as a space for build scripts/instructions. New repo per package.)
  • IBM WML-CE
  • Containers

from olcf-user-docs.

For transparency, I have a WIP branch for some of these topics (primarily focusing on Python, at the moment) in my fork of the repo. That branch re-instates a top-level software section with the intention of covering only site-specific guides, and less machine-specific information. It's also mostly just a broad skeleton layout for software documentation at the moment and can be expanded or trimmed back as desired.

Again, the only real content on it is the site-generalized python guide/faq. If we want to keep software docs in the machine guides as the above conversations suggest, then the python guide can be restructured however makes better sense. Though I'd like to avoid maintaining duplicate, overlapping docs on a software topic in multiple files/guides so a top-level software section (with reduced scope compared to what was on the wordpress site) make sense to me. Ie, just software guides with site-specific special sauce; not lists of software on each machine or descriptions of mundane common packages.

The contribution guide suggests that we keep personal branches out of this repo and only merge when ready. That said, If we wanted to go with a top-level/centralized software guide section, then I think we ought to keep the branch here to establish the core structure and outline, especially if others will be working on it simultaneously.

from olcf-user-docs.

@mpbelhorn @isubsmith Let's bump the priority of this, if we're able. Talking with @NickRF about getting ARM tools into the new docs, and it would be good to have structure in place that can be copied for vendors. (I'm thinking IBM WML like #125, too.)

Edit: Even a simple MR with 1 package would be useful, just to capture our desired reST structure.

from olcf-user-docs.