matensemble.utils module

matensemble.utils.setup_dashboard(status_file)[source]
Return type:

None

Parameters:

status_file (str)

matensemble.utils.create_app(status_file)[source]

Create the FastAPI app that will run the web server which serves the status dashboard that users can view on port 8000. Since the workflows will be done on a cluster the user will need to ssh tunnel into the allocation and port forward port 8000 to their local machine in order to view the server

Return type:

FastAPI

Parameters:

status_file (str)

Example

# After launching the chore with dashboard=True note the node and run this command
ssh -L 8000:frontier00206:8000 kaleb@frontier.olcf.ornl.gov