.. _`compute-ood`:

=================
RIS Open OnDemand
=================

.. contents::
   :depth: 1
   :local:

.. admonition:: Compute Resources

    - See the `RIS Service Desk <https://washu.atlassian.net/servicedesk/customer/portal/2/group/6/create/43>`_ for additional assistance.
    - :ref:`User Agreement <compute-user-agreement>`

.. _`compute-ood-description`:

What is Open OnDemand?
----------------------

- "An intuitive, innovative, and interactive interface to remote computing resources" -`Open OnDemand Website <https://openondemand.org/>`__
- Open on Demand or OOD is a web browser based interface that connects to compute resources, in this case, the RIS Compute Platform.

What Does This Mean for Users?
------------------------------

- Access the RIS Compute Platform via a web browser.
- Use any number of supported applications or incorporate their own.
- Navigate the RIS Compute Platform and their computing needs in a GUI instead of via the command line.

.. _`compute-ood-getting-started`:

Getting Started
---------------

- The compute1 platform must be connected to via ``ssh`` at least once prior to connecting to Open OnDemand
  to properly set up the user home directory. Instruction can be found in the :ref:`Compute Quick Start Guide <compute-quick-start>`.
- Point browser to http://ood.ris.wustl.edu.

.. _`compute-ood-files`:

Files
-----

- Display files and directories in the user's home directory.
- Due to OnDemand implementation restrictions, navigation to ``storage1`` or ``scratch1``
  cannot be done through this page.

.. image:: images/OOD/default.file.directory.png

.. _`compute-ood-jobs`:

Jobs
----

- View active jobs
- Use Job Composer to create scripts and launch batch jobs.

Active Jobs
~~~~~~~~~~~

- Lists user's currently pending and running jobs on compute1 (not exclusive to those launched via OnDemand).

.. image:: images/OOD/active.jobs.page.png

- Select the red trash bin to the right of the job listing to terminate a job (same as ``bkill``).
- Select the arrow to the left of the job listing to view job details (same as ``bjobs`` output).

.. image:: images/OOD/active.jobs.details.png

Job Composer
~~~~~~~~~~~~

- Create and launch batch jobs similar to using a ``.bsub`` job file.
- Job and resource parameter information can be found on the
  :ref:`Job Execution Examples <job-execution-examples>` page.

.. image:: images/OOD/job.composer.page.png

- Jobs can be created from:
  - Default template
  - Specified path
  - Existing job (running or completed).

.. image:: images/OOD/new.job.menu.png

- Once a source is selected an editor will become available.

.. image:: images/OOD/job.composer.editor.png

- Sample job file:

.. code::

    #!/bin/bash
    #BSUB -q general
    #BSUB -g /username/groupname
    #BSUB -a 'docker(ubuntu)'

    echo "Hello World"

.. Note::

    - If a member of more than one compute group, specify the LSF User Group with ``#BSUB -G group_name``.
    - The ``-g`` option must be included here.
    - Each bsub option must have its own ``#BSUB`` line.

- Click Save.
- Select Submit to launch a new batch job using a created script.

Clusters
--------

- Launch command-line and batch jobs from a terminal session.
- Access to all compute1 resources available from this client node.

.. image:: images/OOD/terminal.png

.. _`compute-ood-interactive-apps`:

Interactive Apps
----------------

- Run interactive jobs with GUI.
  - Select application name from the `Interactive Apps` dropdown.
  - Configure storage/scratch mounts and resource options for the job.
  - Select `Launch` to submit the job.
- Ability to run custom images that specifically leverage the :ref:`RIS noVNC image <novnc-dockerimage>`
  via the `Custom noVNC Image` application. This application also allows for extended resource usage
  such as spanning multiple hosts.

.. admonition:: Custom noVNC Image Requirement

    The `Custom noVNC Image` in Open OnDemand is only guaranteed to run if leveraging the current RIS noVNC
    version(s) due to the included dependencies and startup scripts. Instruction on extending this image is found
    in the :ref:`RIS noVNC image <novnc-dockerimage>` documentation.

.. _`compute-ood-interactive-sessions`:

My Interactive Sessions
-----------------------

- View pending and running interactive sessions.

.. image:: images/OOD/interactive.sessions.default.png

- Status - Queued: Submitted job is in queue to launch.

.. image:: images/OOD/interactive.sessions.queued.png

- Status - Starting: Job is in the process of launching (image download, startup scripts running, etc).

.. image:: images/OOD/interactive.sessions.starting.png

- Status - Running: Job has started and is ready to launch a GUI.

.. image:: images/OOD/interactive.sessions.running.png

- Job sessions can be terminated in the My Interactive Sessions page.

.. _`compute-ood-terminal`:

Terminal
--------

- There are multiple locations from which a user can launch a terminal.
- Exactly as expected, this is a terminal that is launched through the web-browser allowing users to do command line work.

.. image:: images/OOD/terminal.png