Skip to content

Tools

Draft

This page is still being written.

A tool is a simulation or analysis program that runs in a session on the hub's execution hosts and is displayed in the member's browser, so a member runs it without installing anything. Tools are developed in a repository, built and tested through the contribution pipeline, and published as resources alongside datasets and presentations.

This book covers the three sides of that platform.

  • Tool developers — structuring a tool repository, invoke scripts, tool paths and environment variables, file transfer, the submit command for remote jobs, and Jupyter notebooks as tools.
  • Tool administrators — installing tool dependencies, whitelisting directories, and administering Jupyter.
  • Tool users — running tools, what the usage figures mean, and the simulation usage definitions.

Note

The tool execution platform is separate software from the Hubzero CMS in this repository, so most of what these pages describe cannot be checked against the code here. Each page says at the top which of its material was verified against the CMS and which is platform material carried over from help.hubzero.org unchecked. The administrator pages have been through that pass; the developer and user pages carry their import banner until they have.