Merge pull request #120 from ResearchComputing/dev

Dev

docs/gateways/OnDemand.md

@@ -0,0 +1,98 @@
+## CURC Open OnDemand _(Browser based portal for CURC HPC resources)_
+
+CURC Open OnDemand is a browser based, integrated, single access portal for all of your high performance computing (HPC) resources. CURC Open OnDemand provides a graphical interface to view, edit, download, and upload files, manage and create job templates for CURC's Summit and Blanca clusters, and access CURC interactive applications (visualization nodes, Matlab, and JupyterNotebooks), all via a web browser and with minimal knowledge of Linux and scheduler commands.
+
+### Getting started with CURC Open OnDemand
+
+> **_NOTE:_** _This is a beta release of Open OnDemand currenly only available to CU users_
+ 
+To connect to CURC Open OnDemand, visit [https://ondemand.rc.colorado.edu](https://ondemand.rc.colorado.edu/). The first page of CU Open OnDemand will bring you to a login prompt. Use your CU Research Computing credentials and Duo 2-factor authentication to login. If you need a CU Research Computing account please visit [our account request page](https://curc.readthedocs.io/en/latest/access/logging-in.html) to get started.
+
+![](OnDemand/login_page.png)
+
+### Features
+
+When you have successfully logged into CU Open OnDemand you will see the landing page with the following features broken into tabs along the top of the page: __Files__, __Jobs__, __Clusters__ (shell access), __Interactive Apps__, and __My Interactive Sessions__.
+
+![](OnDemand/landing_page.png)
+
+#### File Menu
+
+The _File_ menu allows you to view and operate on files in three different file spaces: your _home_ directory, _projects_ directory, and (if applicable) shared _PetaLibary_ directories.
+
+Selecting one of the file spaces will open a separate browser window which will allow you to navigate the space in a graphical setting similar to a file browser on a personal computer. From here you can download, upload, create, delete, and open files.
+
+> **_NOTE 1:_** _Use [Globus](https://curc.readthedocs.io/en/latest/compute/data-transfer.html#globus-transfers) to transfer files to `/scratch/summit` or `/rc_scratch.`_
+
+> **_NOTE 2:_** _If you have more than 1 GB of data to transfer, please use [Globus](https://curc.readthedocs.io/en/latest/compute/data-transfer.html#globus-transfers)._
+
+![](OnDemand/home_file.png)
+
+For additional documentation visit [OSC's File Transfer and Management help page](https://www.osc.edu/resources/online_portals/ondemand/file_transfer_and_management).
+
+#### Jobs Menu
+
+Jobs can be monitored, created, edited and scheduled with the job management tools under the _Jobs_ menu.
+
+* __Active Jobs:__ Under the “Active Jobs” tab you can view active jobs. You can choose to view your jobs (or all jobs) as well as choose from specific clusters (Blanca, Summit, Viz-Core, or all Custers). From this menu you can cancel your own jobs.
+
+![](OnDemand/active_jobs.png)
+
+* __Job Composer:__ Create and edit job scripts and schedule jobs under this menu. [OSC's Job Management help page](https://www.osc.edu/resources/online_portals/ondemand/job_management) provides details on its use.
+
+![](OnDemand/job_composer.png)
+
+#### Clusters Menu (i.e. Shell Access)
+
+The _Clusters_ menu provides shell access to login nodes on CURC clusters. The shell terminal is similar to many other tools that provide terminal access.
+
+* __Summit:__ The Summit tab will launch a terminal that RC users can use to manually access an RC Login node. After the tab opens, type your CURC password and accept the Duo push to your phone to complete login to the terminal.
+
+* __Blanca:__ The Blanca tab will launch a terminal that RC users can use to manually access an RC Login node. After the tab opens, type your CURC password and accept the Duo push to your phone to complete login to the terminal. To load the Blanca Slurm environment, make sure to type “module load slurm/blanca upon login. More information on using the Blanca cluster can be found [in the Blanca documentation](https://curc.readthedocs.io/en/latest/access/blanca.html).
+
+#### Interactive Applications Menu
+
+The _Interactive Applications_ menu contains options to launch certain applications that have graphical user interfaces (GUIs), for interactive use on CURC clusters. Current supported applications include a __remote desktop atop the visualization ("Viz") cluster__ (aka "EnginFrame"), __MATLAB__, and __Jupyter Notebook__.
+
+##### Remote Desktop (Viz-Core VNC)
+
+1. When starting a Remote Desktop session on the _Viz_ cluster you may customize the resources allocated to the session and other characteristics of the dispatched Slurm job. The default will open a Remote Desktop with 1 node (2 cores) for 1 hour (no need to specify account).
+![](OnDemand/viz_launch.png)
+2. Click “launch” to submit the Remote Destop job to the queue. The wait time depends on the number of other users presently on the resource. Requesting smaller, shorter jobs may faciliate shorter wait times. 
+3. When your Remote Desktop is ready you can click the “Launch VIZ CORE VNC.” In most cases the default compression and image quality will suffice but if you do have problems with image quality you can adjust these settings as necessary. 
+4. With the Remote Desktop session running and open, you should be able to run standard Linux desktop applications that have a graphical user interface (GUI). Instructions to use graphical software can be found at the [RC EnginFrame page](https://curc.readthedocs.io/en/latest/gateways/enginframe.html#step-3-use-graphical-software).
+
+> **_NOTE:_** _Closing the window will not terminate the job, you can use the “My Interactive Sessions” tab to view all open interactive sessions and terminate them._
+
+##### MATLAB
+
+1. When starting an interactive MatLab job you may customize the resources allocated to the session and other characteristics of the dispatched Slurm job including the Matlab version. In most cases the defaults will be adequate (i.e, no need to specify an account).
+![](OnDemand/matlab_launch.png)
+2. Click “launch” to submit the MATLAB job to the queue. The wait time depends on the number of cores, nodes, and time requested.
+3. When your Matlab session is ready you can click the “Launch MATLAB on Core- CURC” In most cases the default compression and image quality will suffice but if you do have problems with image quality of the Remote Desktop you can adjust as necessary. An interactive Matlab session will be started in a new window.
+
+> **_NOTE:_** _Matlab can also be opened in the Remote Desktop (VIZ CORE VNC), once you’ve opened a Remote Desktop session instructions can be found at the [RC EnginFrame page](https://curc.readthedocs.io/en/latest/gateways/enginframe.html#step-3-use-graphical-software). Some users find running Matlab in the Remote Desktop (VIZ CORE VNC) option provides an enhanced experience._
+
+> **_NOTE:_** _Closing the window will not terminate the job, you can use the “My Interactive Sessions” tab to view all open interactive sessions and terminate them._
+
+##### Jupyter Notebook
+
+1. When starting an interactive JupyterHub job you may customize the resources allocated to the session and other characteristics of the dispatched Slurm job. In most cases the defaults will be adequate (i.e, no need to specify an account or partition).
+
+> **_NOTE:_** _Jobs are currently limited to 1 core per node requested._
+
+2. Click “launch” to submit the JupyterNotebook job to the queue. The wait time depends on the number of nodes and cores as well as time requested.
+![](OnDemand/jupyter_launch.png)
+3. Once your Jupyter Notebook session is ready you can click the “Launch Jupyter Notebook” In most cases the default compression and image quality will suffice but if you do have problems with image quality of the Remote Desktop you can adjust as necessary. An interactive Jupyter Notebook session will be started in a new window.
+4. For more information on running Jupyter Notebooks [check out RC’s page on Jupyter](https://curc.readthedocs.io/en/latest/gateways/jupyterhub.html).
+
+> **_NOTE:_** _Closing the window will not terminate the job, you can use the “My Interactive Sessions” tab to view all open interactive sessions and terminate them._ 
+
+> **_NOTE:_** _Users can also run Jupyter Notebooks in the CURC Jupyterhub at https://jupyter.rc.colorado.edu_. 
+
+#### My Interactive Sessions
+
+The _My Interactive Sessions_ menu will let you view and manage all of your current open Interactive applications. From this window you can view the node/core count, status, as well as time remaining for current sessions. 
+
+Closing the window an interactive application is opened in will not terminate the session, you will need to click the “Delete” button for the individual session.
+![](OnDemand/my_interactive_sessions.png)

docs/index.rst

@@ -103,6 +103,7 @@ Use of University of Colorado Research Computing resources, including (but not l
    gateways/jupyterhub
    gateways/enginframe
    gateways/xdmod
+   gateways/OnDemand
 
 .. toctree::
    :maxdepth: 2