Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
minLevel3
Introduction to SEAGrid Gateway

...

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 -

...

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’ > Create’ from the main menu. Enter Project Name (Mandatory) & Project Description (Optional)  
  3. Enter required mandatory information and Save.
  4. Project creation Screen
    Screen Shot 2014-09-08 at 12.14.31 PM.pngImage RemovedImage Added

    Image II - Create Project

  5. Prior to submission, fields can be cleared using Clear buttonWhile 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 keys are;
    1. Project Name
    2. Project Description
    for projects using name or description
  3. Search Project Page;
    Image RemovedImage Added
    Image III - Search Project

  4. After selecting All the search by key, user has to give  a value to search using the selected key. Click on Search.All the Projects as per entered key value pair will 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 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; all experiments created under this page displays all experiments in the project will be listed. User can click on an experiment name and navigate to ‘Experiment Summary’ page.
  7. To navigate through traverse through existing projects use 'Next' button on top of the list on right.

Image RemovedImage Added

Image IV - Project Summary

Image Removed

Image V - Experiment 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 III - Create & Launch Experiment

Create Experiment

  1. To create an experiment; Navigation Experiment --> Create Experiment
  2. Create Experiment Page - Experiment Information
    Screen Shot 2014-09-08 at 1.59.12 PM.png
    Image VI - Create Experiment

  3. 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.
  4. Then continue entering Application configuration information.
    1. 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.
    2. Compute Resource (select from the available LOV)
    3. Node Count 
    4. Total Core Count
    5. Wall Time Limit 
  5. 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.
  6. Create Experiment - Application Configuration Part
    Screen Shot 2014-09-08 at 2.11.10 PM.png
    Image VII - Create Experiment Contd..

  7. While entering application configurations user can start over from the beginning using ‘Start Over’ button.
  8. Once saved or Saved and launched user will be directed to ‘Experiment Summary’ page; can refresh the page and monitor experiment status changes.
  9. Experiment Summary Page

    Image VIII - Experiment Summary

Launch Experiment

  1. To launch an experiment can use the same 'Create Experiment' screen. Apart from saving the experiment user can Save & Launch at the same time using button ‘Save and Launch’.

  2. User can also create and save the experiment to launch later. To launch later 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 - 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 X - 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.

...

Tutorial VI - 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

Screen Shot 2014-09-09 at 3.23.32 PM.png

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

...