Documentation notes

[huiwanpnnl]

This "issue" is a notepad to remind myself to (1) include certain contents and (2) clarify things with Seb then explain them in the documentation.

(BTW, on March 18, 2026, I attended NERSC's HPC-BP webinar titled "One Good Tutorial: Defining a 'Minimum Viable Documentation Product' for Scientific Software". The presenter's perspectives were quite consistent with what we have been doing and his website has a nice checklist plus useful additional resources: https://onegoodtutorial.org/.)

Thoughts and to-do items:

• Installation
  • Use Compy at PNNL as an example to discuss installation and usage on other (non-NERSC) HPC systems?
  • Do we still provide binaries for laptops/desktops?
• File loading
  • The current "file loading" dialogue window has a button "import state file". Was this put in as a placeholder? Is it supposed to be removed, now that we have 2 separate buttons and shortcuts for exporting/importing state file?
  • Test state file export/import; then complete the respective section of documentation for the website.
• Variable selection
  • Complete the section for the website.

Things clarified:

• For using NERSC deployment, we recommend only the JupyterHub? I tried using a terminal app to connect to NERSC's login node and start QuickView. I got a URL http://localhost:43195/; the browser said "this site can't be reached".
• Even when using NERSC, state files will be downloaded to and uploaded from the laptop/desktop.

[jourdain]

You should be all-set