SEAGrid Portal User Guide

Introduction to SEAGrid Gateway

Hosted SEAGrid portal is the UI developed by the Airavata team for interested science communities to work with. This user guide provides step-by-step information on obtaining a complete science gateway experience for science and scholarly communities using Airavata as a middleware platform. In the user guide we would also discuss main features and services provided for gateway communities via Airavata.

User guide will tell you;

• How to register users in the portal.
  

• What are projects and how to use them.

• How to create, launch and monitor experiments.

• Sharing your work with others.

• Using own allocation for job submissions in compute resources.

• How to get help, provide feedback and request for new applications.

For more details on Airavata middleware visit Airavata site

Gateway Details

1. Hosted SEAGrid Gateway link;
   https://seagrid.org/
2. Download application input files from;
   Sample application input files I 
   Sample application input files II 

Tutorial I - Gateway Login

Create Account

1. A new user has to create an account using ‘Create account’ link on top right hand corner of the gateway.
2. To create an account;
   1. Please enter mandatory information and submit. A confirmation message will confirm the creation.
   2. Important;
      1. Username cannot have spaces.
      2. Username & password must be longer than 5 characters.
      3. Password is case sensitive, need at least one number, one special character (!@#$%), at least one upper case letter and one lower case letter.
      4. Enter all the mandatory fields indicated by a star; *.
   3. Account creation page: https://seagrid.org/create
      

Account Confirmation and Verification

1. Once the account is created you will receive an email to confirm the account creation.To confirm use the link provided in the email and follow given instructions.

2. Till the gateway administrator verifies and enable the account; you will not be able to submit jobs on compute resources.

3. Once the account is enabled the account owner will receive an email notification on new gateway privileges.

4. Gateway admin might even contact the user over email to get more information on research interests in order to assist the user.

Login to Account

1. Once the account is created successfully; login to the gateway using the created account.
2. Gateway login screen link
   1. https://seagrid.org/login
3. OR use the 'Log In' link given on the 'Create New Account' page after account retain is successful.
4. Login Page;

Image I - Login

Tutorial II - Add Own Cluster Allocation Details

1. Gateway user can use their own compute resource(cluster) allocation within the gateway to launch jobs.
2. Prior to using the allocation users need to set up the allocation account details in the gateway.

Add Allocation Details

1. Navigate to User Settings (This is under gateway username in the menu on righthand side.
   
   Image II - User Settings Navigation
2. User Settings Screen
   
   Image III - User Settings
3. Select Compute Resources from above to add allocation details.
4. Click 'Add a Compute Resource Account'
5. Select the resource from the dropdown list.
6. Provide the required information. NOTE: You may not have allocation project, QOS or Reservation. Minimum requirement is the login username and the scratch location and SSH key.
7. When assigning SSH key by default the default SSH key will be assigned. If user prefers can generate a new key and assign here.

Generate SSH Key

1. For individual users to generate new SSH key navigate to User Settings → Credential Store
2. In Credential store you will have the default key displayed and can be copied.
3. To generate a new key provide a description and add.
   
   Image IV - User Settings → Credential Store
4. User can delete keys and also tag any key as the 'default' SSH key

Add SSH Key to Authorized Keys

1. SSH keys are generated for secure communication between airavata middleware and compute resource.
2. Once SSH key is generated, it needs to be added to the authorized keys file for user in the respective compute resource/cluster.
3. To add the SSH key login to your account in the cluster.
4. Navigate to .SSH directory and open authorized_keys.
5. Add the SSH key assigned in user settings and save.
6. If you have don't have .ssh directory or the authorized_keys file, create them.

Tutorial III - Use Projects

Use Project

1. Projects are used to group experiments, they are containers. Experiments in the gateway has one to one mapping with jobs launched to compute resources.
2. To create Projects, navigate to ‘Project --> Create’ from the main menu. 
3. Enter required mandatory information and Save.
4. Project creation Screen
   
   
   Image V - Create Project
   
   
5. While creating the project user can share the project with other gateway users.
6. Upon saving you will be navigated to Project Summary page.

Browse Projects

1. Screen navigation 'Project --> Browse' from the main menu.
2. Search for projects using name or description
3. Search Project Page;
   
   Image VI - Search Project
   
   
4. All the projects matching your search criteria will be listed.
5. User can search for all projects by using (*) as a wild character. The * can be used when searching either options; project name or description.
6. When projects are listed by clicking ‘View’ at the end of the row user can navigate to ‘Project Summary’ page; this page displays all experiments in the project. User can click on an experiment name and navigate to ‘Experiment Summary’ page.
7. To traverse through existing projects use 'Next' button on top of the list on right.

Image VII - Project Summary

Edit Projects

1. Existing projects can be modified. The name, description can be changed.
2. Project sharing can be changed as well. Project owner can add or remove the shared users.

Tutorial IV - Create & Launch Experiment

Create Experiment

1. Experiment is the equivalent of a job on gateway side.
2. To create an experiment; Navigation Experiment → Create Experiment
3. Create Experiment Page - Experiment Information
   
   Image VIII - Create Experiment
   
   
4. Initially user need to enter/select given fields in order to continue.
   1. Experiment Name (Mandatory)
   2. Experiment Description (Optional)
   3. Project (Select from the available LOV)
   4. Application (Select from the available LOV)
   and click on ‘Continue’ button. If user requires to clear any entered fields can click ‘Reset Values’ before continuing.
5. Then continue entering Application configuration information.
   1. Sharing Settings - In this section user can share this experiment with other gateway users. Use 'Share with Other Users' and search for gateway users and share. When sharing can specify whether 'read' or 'write' permission to provide.
      
   2. Experiment application input (Mandatory) - Application input can be in the form of entering data manually or uploading a single or multiple files.
      NOTE: Uploading file validity is not checked by the gateway. User has the responsibility of uploading correct files.
   3. Compute Resource (select from the available LOV)
   4. Use My Compute Resource Account  - This checkbox will be checked by default if user have added user settings for the select compute resource. User can un-check the box and use community allocation to submit jobs to compute resource.
   5. Node Count 
   6. Total Core Count
   7. Wall Time Limit 
6. NOTE:
   1. For values c, d and e if user does not enter,  default value will be taken as the input.
   2. For c and d user has to enter a value greater than or equivalent to 1.
   3. For e user has to enter a value greater than or equivalent to 0.
   4. Values to c and d could be decided sometimes based on the application or/and resource. Inserting the accurate values are currently in the hands of the user.
7. Create Experiment - Application Configuration Part
   
   Image IX - Create Experiment Contd..
   
   
8. While entering application configurations user can start over from the beginning using ‘Start Over’ button.
9. Once saved or Saved and launched user will be directed to ‘Experiment Summary’ page; can refresh the page and monitor experiment status changes.
10. Experiment Summary Page
    
    Image X - Experiment Summary

Launch Experiment

1. To launch an experiment user can Save & Launch in create experiment page above.

2. For previously saved experiments, to launch user has to navigate to 'Experiment Summary' Page.

3. If the experiment is not suppose to be launched e.g.: a COMPLETED, LAUNCHED experiment, then the launch button will be disabled.

Tutorial V - Browse Experiments

1. User can search for experiment created by him/her through

1. Experiments → Browse

2. Browse Projects → View Project → View Experiment (by clicking on the status of the experiment) - Please refer Search Projects in Tutorial II above.

2. In Search Experiments search keys are;

1. Experiment Name

2. Experiment Description

3. Application

4. …

3. Browse Experiments Page

   

   Image XI - Search Experiments

4. All the experiments of the user will be listed; latest on top. User  can also select the search by key, user has to give  a value to search for using the key. Partial values, complete values, (*) wild card can be used to search.

5. Click on Search once the search key is selected and value is entered. User can also search for experiments by giving the status.

6. All the experiments as per entered Key value pair will be listed.

7. By clicking on the 'Status' user will be navigated to ‘Experiment Summary’ screen of each experiment.

8. In experiment summary users can;

   1. Launch experiment - Explained in above Tutorial IV

   2. Cancel experiment

   3. Clone experiment

   4. Edit experiment

9. User can edit an experiment by navigating to 'Edit Experiment' page. Edit button next to each experiment name will navigate user to 'Edit Experiment' page of each experiment.

Tutorial VI - Modify, Cancel & Clone Experiments

Modify Experiment

1. Modify experiment by clicking on the edit icon (pencil) next to experiment name OR by clicking on ‘Edit’ button in Experiment Summary Page.

2. User can modify all available fields except experiment status, application & experiment ID.  

3. User can update experiments with statuses;

1. CREATED

2. VALIDATED

4. Edit Experiment Page

Image XII - Edit Experiment

Cancel Experiment 

1. Experiments can be canceled by navigating to experiment’s 'Experiment Summary’ screen.
2. Experiment statuses which allows cancellations;
   1. LAUNCHED
   2. EXECUTING
   3. SCHEDULED
3. Click on ‘Cancel’ button and immediately the Experiment status will change to CANCELING.
4. If the job is not already processing in the remote resource the job will proceed to COMPLETE and upon completing the experiment status will change to CANCELLED. Since the user requested a cancellation generated output will not be provided back to the gateway.
5. If the job was successfully CANCELLED upon changing the job state to CANCELLED experiment status will also change to CANCELED.
6. CANCELED experiments are only available for cloning in the PGA.

Clone Experiment

1. Experiments can be cloned irrespective of the experiment status by clicking ‘Clone’ in ‘Experiment Summary’ page.

2. When clicks ‘Clone’ from experiment summary user will be navigated to ‘Edit Experiment’ page of the new experiment. The new experiment will have exact same information as the earlier existing experiment.   

3. The new experiment will have a new experiment ID and the status will always be CREATED.

New experiment name = Clone of + Old experiment name

1. User can change existing information in ‘Edit Experiment’ page and save or save & launch.

Tutorial VII - User Assistance

Report Issue

1. Gateway user can report issues faced within the gateway through this page.

2. Page navigation: Help → Report Issue

3. Raise a Bug Page

Image XI - Raise a Bug

Request Feature

1. Gateway allows users to provide feedback as well as request for new applications via Request Feature Page.

2. Page Navigation; Help → Request Feature

3. Got Feedback? Page

Image XII - Got Feedback?