Commit 6ba4ce8b authored by Adam Caprez's avatar Adam Caprez
Browse files

Merge branch 'ood-documentation' into 'master'

Adding OOD documentation

See merge request !226
parents 8c7fbaa4 bb4b742d
title = "The Open Science Grid"
description = "How to utilize the Open Science Grid (OSG)."
weight = "80"
weight = "90"
If you find that you are not getting access to the volume of computing
title = "Anvil: HCC's Cloud"
description = "How to use Anvil, HCC's OpenStack-based cloud resource"
weight = "90"
weight = "85"
- [Overview](#overview)
......@@ -16,5 +16,11 @@ If you are not familiar with using command line Linux, check out these resources
- [Basic Linux Commands]({{< relref "basic_linux_commands">}})
- [Software Carpentry Introduction to the Unix Shell Lesson](
{{% notice tip %}}
Steps 2 and 3 above represent the traditional way of connecting to the HCC clusters. An alternative way to connect is through the [HCC OnDemand web portal]({{< relref "open_ondemand" >}}) which provides web-based access to a variety of tools including: virtual desktop, jupyter notebook, login shell, file manager, and job composer.
{{% /notice %}}
[X11 forwarding]({{< relref "" >}}) allows the use of GUI applications remotely.
title = "HCC OnDemand"
description = "Using HCC Open OnDemand Web Interface"
weight = "80"
HCC resources can be accessed through the Open OnDemand web portal. This allows researchers to manage files, create, submit and monitor jobs, access the shell on HCC clusters, spawn Jupyter Notebooks, and interact with a virtual desktop environment for GUI applications. All of this is done through a web browser and requires no installation of additional applications.
This guide covers the following HCC OnDemand topics and functions:
- [Connecting to HCC OnDemand]({{< relref "connecting_to_hcc_ondemand" >}})
- [Managing and Transferring Files]({{< relref "managing_and_transferring_files" >}})
- [Job Management and Submission]({{< relref "job_management_and_submission" >}})
- [Shell Access]({{< relref "shell_access" >}})
- [Virtual Desktop and Jupyter Notebooks]({{< relref "virtual_desktop_and_jupyter_notebooks" >}})
*Open OnDemand was developed at the Ohio Supercomputer Center and is funded by the National Science Foundation. For more information about the Open OnDemand project, please visit their [website](*
title = "Connecting to HCC OnDemand"
description = "Connecting to HCC OnDemand"
To access HCC’s instance of Open OnDemand, use one of the following links.
- For Crane, visit: [](
- For Rhino, visit: [](
Log in with your HCC username, password, and Duo credentials.
{{< figure src="/images/OOD_login_1.png" width="700" class="img-border">}}
{{< figure src="/images/OOD_login_2.png" width="700" class="img-border">}}
Once you have successfully logged in, you will be directed to your OnDemand dashboard which displays the Message of the Day and the menu bar at the top of the window.
{{< figure src="/images/OOD_Dashboard_1.png" width="700" class="img-border">}}
To return to the Dashboard at any point, click on "Crane OnDemand" in the upper left hand corner of the window.
Next: [Managing and Transferring Files with HCC OnDemand]({{< relref "managing_and_transferring_files" >}})
title = "Job Management and Submission with HCC OnDemand"
description = "Job Management and Submission with HCC OnDemand"
Users can manage active jobs, as well as create, edit, and submit jobs from the OnDemand portal as follows.
To monitor active jobs, select "Jobs" -> "Active Jobs" from the OnDemand Dashboard menu bar.
{{< figure src="/images/OOD_Active_jobs_1.png" width="700" class="img-border">}}
This will display all of your active jobs in a tabular format.
{{< figure src="/images/OOD_Active_jobs_2.png" width="700" class="img-border">}}
You can re-order the list by clicking on the up/down arrow icon located next to each column heading, or remove specific jobs by clicking on the trash can icon next to the job. A more detailed description of a job is displayed when you click on the ">" icon to the left of the JobID.
To create, edit, and submit new jobs, select "Jobs" -> "Job Composer" from the Dashboard menu bar.
{{< figure src="/images/OOD_Job_composer_1.png" width="700" class="img-border">}}
Clock on the "?Help" button in the upper right hand corner of the window for a step-by-step introduction to the Job Composer features and how to use it.
{{< figure src="/images/OOD_Job_composer_2.png" width="700" class="img-border">}}
To view a list of job templates for various applications, select the "Templates" tab at the top of the page. If you would like to start your job from one of these templates, select the template and then click "Create New Job".
{{< figure src="/images/OOD_Templates_1.png" width="700" class="img-border">}}
You will then be able to edit and submit the job from the Job Composer page.
Next: [Shell Access with HCC OnDemand]({{< relref "shell_access" >}})
title = "Managing and Transferring Files with HCC OnDemand"
description = "Managing and Transferring Files with HCC OnDemand"
From the OnDemand portal, you can view, edit, rename/move, upload/download, copy, create, and delete files and directories. First, choose the file system you would like to access (`/home`, `/work`, or `/common`) by selecting it from the "Files" drop-down menu.
{{< figure src="/images/OOD_Files_menu_1.png" width="700" class="img-border">}}
You will be directed to the File Explorer page which displays the directory contents of the chosen file system and provides a user-friendly interface for file operations and transfers.
{{< figure src="/images/OOD_File_explorer_1.png" width="700" class="img-border">}}
Basic file operations can be accomplished by selecting a file or directory and clicking on the button for the desired operation. Selecting a text file and then clicking the "Edit" button will open up a separate tab with a text editor, allowing you to modify text files directly through the portal.
{{< figure src="/images/OOD_File_explorer_2.png" width="700" class="img-border">}}
{{< figure src="/images/OOD_Text_editor_1.png" width="700" class="img-border">}}
Switching to a different file system from within the File Explorer page is done by clicking on "Go To..." any typing in the desired directory path. For example, if you are in your `/home` directory and want to switch to your `/work` directory, type `/work/<groupname>/<username>` in the pop-up window, and then click "OK".
{{< figure src="/images/OOD_Go_to_1.png" width="700" class="img-border">}}
To transfer files between your computer and the cluster file system through OnDemand, use the "Upload" and "Download" buttons in the portal's File Explorer interface. Clicking the "Upload" button and then "Choose Files" will open a local file browser window for you to select which file(s) you want to upload. Alternatively, you can drag and drop a file from your computer's file explorer to the OnDemand window to upload it.
{{< figure src="/images/OOD_Upload_1.png" width="700" class="img-border">}}
To download files to your local computer, select the files and directories you want (using `Ctrl+click` and `Shift+click` to select multiple items), and then click the "Download" button.
{{< figure src="/images/OOD_Download_1.png" width="700" class="img-border">}}
Next: [Job Management and Submission with HCC OnDemand]({{< relref "job_management_and_submission" >}})
title = "Shell Access with HCC OnDemand"
description = "Shell Access with HCC OnDemand"
To access the shell on the cluster, from the menu at the top of the OnDemand Dashboard, select "Clusters" -> "<Cluster> Shell Access" (where \<Cluster\> is the name of the OnDemand server you are logged into.
{{< figure src="/images/OOD_Shell_1.png" width="700" class="img-border">}}
This will open a secure shell connection for you on the login node of the cluster. From here, you can use the command-line to interact with the cluster as you would normally. Close the tab when you want to exit the shell.
{{< figure src="/images/OOD_Shell_2.png" width="700" class="img-border">}}
Next: [Virtual Desktop and Jupyter Notebooks with HCC OnDemand]({{< relref "virtual_desktop_and_jupyter_notebooks" >}})
title = "Virtual Desktop and Jupyter Notebooks with HCC OnDemand"
description = "Virtual Desktop and Jupyter Notebooks with HCC OnDemand"
You can launch a virtual desktop environment or a Jupyter Notebook by choosing the appropriate selection from the "Interactive Apps" drop-down menu at the top of the OnDemand Dashboard page.
{{< figure src="/images/OOD_Interactive_apps_1.png" width="700" class="img-border">}}
Then fill in the parameters needed by your job (e.g. number of cores, run time, requested RAM, queue type, partition, etc.) and click "Launch". The job will queue and begin running when a slot is available.
{{< figure src="/images/OOD_Interactive_apps_2.png" width="700" class="img-border">}}
If you've launched a virtual desktop, click "Launch Desktop" once the job begins running. A virtual desktop window will open, and from here you will be able to run interactive GUI applications on a cluster worker node.
{{< figure src="/images/OOD_Desktop_1.png" width="700" class="img-border">}}
If you've launched a Jupyter Notebook, click "Connect to Jupyter" once the job begins running. This will spawn a new Jupyter Notebook server and open a window with the familiar Jupyter interface.
{{< figure src="/images/OOD_Jupyter_1.png" width="700" class="img-border">}}
Be sure to delete desktop and Jupyter jobs once you are finished with them by selecting the "My Interactive Sessions" button on the OnDemand menu bar and then clicking the red "Delete" button next to the job.
{{< figure src="/images/OOD_Delete_desktop_1.png" width="700" class="img-border">}}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment