Tools
Accessing outside computing resources
A tool runs in a tool session on the hub's execution hosts. The session
carries the interface the user works in. Light calculations run in the
session itself; heavier ones are sent to a cluster or a national resource
with the submit command, which keeps the session responsive and returns
the results when the job finishes.
The pages here
Most tools reach submit from a Jupyter notebook now, so
Submitting from a Jupyter notebook is the page to
read if you are writing a new tool; the submit command reference below
explains what the options it sets actually do.
- Submit command — what
submitdoes, its options, and the parameter sweep syntax. Start here whichever way you call it. - Submitting from a Jupyter notebook — calling
submitfrom a cell, and theSubmitCommandclass from thehubzero.submitlibrary. - Pegasus workflow submission — running a workflow you
built yourself, rather than a sweep
submitgenerates for you. - Submitting from a Rappture tool — kept for hubs that still run Rappture tools. Rappture is deprecated; do not start a new tool with it.
Related reading: Jupyter notebooks as tools for publishing a notebook in the first place, and registering a tool for the publishing option that marks a tool as a web application.
Reviewed against 2.4-main @ e097e0236d on 2026-09-10.