Difference between revisions of "General/OOD"

From HPC
Jump to: navigation , search
m (Menu options)
m
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
Viper Open OnDemand is a web portal that provides a single access point to a full range of ways to make use of Viper. Currently Viper Open Ondemand is only available on the University network, so you must be on campus or connected via VPN. In the future it is anticipated that it will be made accessible from off campus network with Multi Factor Authentication (MFA).
+
Viper Open OnDemand is a web portal that provides a single access point to a full range of ways to make use of Viper. Currently, Viper Open OnDemand is only available on the University network, so you must be on campus or connected via VPN. In the future, it is anticipated that it will be made accessible from off campus network with Multi-Factor Authentication (MFA).
 +
 
 +
'''Please note:''' Viper Open OnDemand is currently in pilot, please raise any issues experienced via the "Contact Support" link under Help on the Viper Open OnDemand page
  
 
== Capabilities ==
 
== Capabilities ==
Line 7: Line 9:
 
* Full shell access, much like an SSH connection you can have full terminal access
 
* Full shell access, much like an SSH connection you can have full terminal access
 
* Job management, including job creation and submission, monitoring and cancellation
 
* Job management, including job creation and submission, monitoring and cancellation
* Run web front end applications such as Jupyter Notebooks and RStudio
+
* Run web front-end applications such as Jupyter Notebooks and RStudio
 
* Graphical user interface sessions for applications such as Matlab and Stata
 
* Graphical user interface sessions for applications such as Matlab and Stata
* Remote desktop access, providing full featured desktop sessions
+
* Remote desktop access, providing full-featured desktop sessions
  
 
== Connecting to Viper Open OnDemand ==
 
== Connecting to Viper Open OnDemand ==
* Incognito mode - it is recommended to connect to Viper Open OnDemand from a private or incognito browser window. This is due to some caching issues making your browser think you are logged in when you are not.
+
#'''Incognito mode''' - it is recommended to connect to Viper Open OnDemand from a private or incognito browser window. This is due to some caching issues making your browser think you are logged in when you are not.
* Logging in to Viper Open OnDemand is via Microsoft 365 MFA page (though MFA not currently configured). Enter your email address, click Next,
+
#https://viperood.hpc.hull.ac.uk
[[File:SSO.png]]
+
<!--* Logging in to Viper Open OnDemand is via Microsoft 365 MFA page (though MFA is not currently configured). Enter your email address, click Next,-->
 +
#Log in using your university credentials - note unlike logging into Viper via SSH, in this situation you need to log in with your University email address.
 +
[[File:Newsso.jpg]]
  
 
== Menu options ==
 
== Menu options ==
Line 21: Line 25:
 
* '''Jobs''' - View active jobs and create batch jobs.
 
* '''Jobs''' - View active jobs and create batch jobs.
 
* '''Clusters''' - Command Line Access to Viper.
 
* '''Clusters''' - Command Line Access to Viper.
* '''Interactive Apps''' -  Graphical Interfaced applications on Viper
+
* '''Interactive Apps''' -  Graphical Interfaced applications on Viper.
 
* '''Job Submissions''' - Create an environment for Jupyter Notebook.
 
* '''Job Submissions''' - Create an environment for Jupyter Notebook.
 
* '''My Interactive Sessions''' - View your previously run OOD jobs.
 
* '''My Interactive Sessions''' - View your previously run OOD jobs.
Line 33: Line 37:
 
*Submit batch jobs
 
*Submit batch jobs
 
*Use the Jupyter Environment Creator
 
*Use the Jupyter Environment Creator
 +
 
===Files===
 
===Files===
Through this explorer you can upload and download files, copy and move files within your Viper home directory or create new files or folders. You can also open a terminal in a chosen folder within your browser window.
+
Through this explorer, you can upload and download files, copy and move files within your Viper home directory or create new files or folders. You can also open a terminal in a chosen folder within your browser window.
 +
 
 +
'''Note''': the files explorer in Viper OnDemand may not be appropriate for very large data transfers (i.e. 10GB+) in which case a solution like [[http://hpc.mediawiki.hull.ac.uk/Training/Transferring_Data#Linux FileZilla]] is recommended.
 +
 
 
===Jobs===
 
===Jobs===
 
====Active jobs====
 
====Active jobs====
View your and other users jobs.
+
View your and other users' jobs.
 
====Compose Job====
 
====Compose Job====
 
You can submit a [[Quickstart/Batch Jobs| batch job]] by using the Job Composer.
 
You can submit a [[Quickstart/Batch Jobs| batch job]] by using the Job Composer.
#Create a new job from specified path
+
#Create a new job from the specified path
 
#Enter the path to the directory your submission script is in
 
#Enter the path to the directory your submission script is in
 
#Give the job a name
 
#Give the job a name
#Enter the name of the submission script or leave this blank this for now - you can change this later under job options
+
#Enter the name of the submission script - you can change this later under job options
 
#Click Save
 
#Click Save
 
#Select the job and click submit
 
#Select the job and click submit
 +
[[File: Jobcomposer.jpg]]
 +
Under the job options, you can change the job title, select a submission script, and add an [[FurtherTopics/Advanced Batch Jobs#Array batch job| array]] specification.
  
 
===Clusters===
 
===Clusters===
 
Access to Viper via the command line. For guidance on using the command line please visit our [[Main Page#Quickstart| Quickstart]].
 
Access to Viper via the command line. For guidance on using the command line please visit our [[Main Page#Quickstart| Quickstart]].
 +
 
===Interactive Apps===
 
===Interactive Apps===
 
====Launch====
 
====Launch====
Before launching you need to give your job a name and select how long it is going to take. You can pick a version, how many cores, and a queue for your application you would like to launch. Please always pick exclusive for Matlab and R Studio.
+
Before launching you need to give your job a name and select how long it is going to take. You can pick a version, how many cores, and a queue for the application you would like to launch. Please always pick exclusive for Matlab and R Studio.
 
[[ File:LaunchOOD.png ]]
 
[[ File:LaunchOOD.png ]]
  
Line 62: Line 73:
 
*[[OOD/Jupyter Notebook| Jupyter Notebook]]
 
*[[OOD/Jupyter Notebook| Jupyter Notebook]]
 
*Matlab is a numerical computing environment and programming language developed by MathWorks, MATLAB allows matrix manipulations, plotting of functions and data, and implementation of algorithms. A range of toolboxes is available to extend functionality.
 
*Matlab is a numerical computing environment and programming language developed by MathWorks, MATLAB allows matrix manipulations, plotting of functions and data, and implementation of algorithms. A range of toolboxes is available to extend functionality.
*R Studio- R is an open-source programming language and software environment for statistical computing & graphics.
+
*[[OOD/R Studio|R Studio]] R is an open-source programming language and software environment for statistical computing & graphics.
 
*Stata is a commercial statistical package, which provides a complete solution for data analysis, data management, and graphics.  
 
*Stata is a commercial statistical package, which provides a complete solution for data analysis, data management, and graphics.  
 
*[[OOD/Openbox| Openbox]]
 
*[[OOD/Openbox| Openbox]]
  
 +
===My Interactive Sessions===
 +
View your interactive sessions from Viper OnDemand.
 
<!--
 
<!--
 
== Interactive Apps ==
 
== Interactive Apps ==

Revision as of 16:33, 16 November 2023

Introduction

Viper Open OnDemand is a web portal that provides a single access point to a full range of ways to make use of Viper. Currently, Viper Open OnDemand is only available on the University network, so you must be on campus or connected via VPN. In the future, it is anticipated that it will be made accessible from off campus network with Multi-Factor Authentication (MFA).

Please note: Viper Open OnDemand is currently in pilot, please raise any issues experienced via the "Contact Support" link under Help on the Viper Open OnDemand page

Capabilities

Viper Open OnDemand provides the following capabilities via the web browser:

  • File and data management via a file explorer app
  • Full shell access, much like an SSH connection you can have full terminal access
  • Job management, including job creation and submission, monitoring and cancellation
  • Run web front-end applications such as Jupyter Notebooks and RStudio
  • Graphical user interface sessions for applications such as Matlab and Stata
  • Remote desktop access, providing full-featured desktop sessions

Connecting to Viper Open OnDemand

  1. Incognito mode - it is recommended to connect to Viper Open OnDemand from a private or incognito browser window. This is due to some caching issues making your browser think you are logged in when you are not.
  2. https://viperood.hpc.hull.ac.uk
  3. Log in using your university credentials - note unlike logging into Viper via SSH, in this situation you need to log in with your University email address.

Newsso.jpg

Menu options

  • Apps - All features available.
  • Files - file explorer providing access to your Viper home directory.
  • Jobs - View active jobs and create batch jobs.
  • Clusters - Command Line Access to Viper.
  • Interactive Apps - Graphical Interfaced applications on Viper.
  • Job Submissions - Create an environment for Jupyter Notebook.
  • My Interactive Sessions - View your previously run OOD jobs.
  • Help - Contact support or view our documentation

Viperondemand.png

Apps

  • Access your files
  • View active jobs
  • Access all interactive apps
  • Access the command line
  • Submit batch jobs
  • Use the Jupyter Environment Creator

Files

Through this explorer, you can upload and download files, copy and move files within your Viper home directory or create new files or folders. You can also open a terminal in a chosen folder within your browser window.

Note: the files explorer in Viper OnDemand may not be appropriate for very large data transfers (i.e. 10GB+) in which case a solution like [FileZilla] is recommended.

Jobs

Active jobs

View your and other users' jobs.

Compose Job

You can submit a batch job by using the Job Composer.

  1. Create a new job from the specified path
  2. Enter the path to the directory your submission script is in
  3. Give the job a name
  4. Enter the name of the submission script - you can change this later under job options
  5. Click Save
  6. Select the job and click submit

Jobcomposer.jpg Under the job options, you can change the job title, select a submission script, and add an array specification.

Clusters

Access to Viper via the command line. For guidance on using the command line please visit our Quickstart.

Interactive Apps

Launch

Before launching you need to give your job a name and select how long it is going to take. You can pick a version, how many cores, and a queue for the application you would like to launch. Please always pick exclusive for Matlab and R Studio. LaunchOOD.png

Connect

You can adjust the image quality of the connected session by adjusting the sliders for Compression level (lower value for better quality) and Image Quality (higher value for better quality). Quality.png

Apps Available

  • Fiji is an image processing package—a "batteries-included" distribution of ImageJ, bundling a lot of plugins which facilitate scientific image analysis.
  • Graphical Interactive Session. For guidance on using the command line please visit our Quickstart.
  • Jupyter Notebook
  • Matlab is a numerical computing environment and programming language developed by MathWorks, MATLAB allows matrix manipulations, plotting of functions and data, and implementation of algorithms. A range of toolboxes is available to extend functionality.
  • R Studio R is an open-source programming language and software environment for statistical computing & graphics.
  • Stata is a commercial statistical package, which provides a complete solution for data analysis, data management, and graphics.
  • Openbox

My Interactive Sessions

View your interactive sessions from Viper OnDemand.