Skip to end of metadata
Go to start of metadata

Quick-Start Tutorials

The intention of these tutorials is to provide a quick glimpse into the Airavata middleware by exercising its features through the hosted version of Airavata Reference Gateway written in PHP hence called PGA (PHP Reference Gateway for Airavata). The user can follow the carefully constructed tutorials in order to experience general capabilities of the middleware.

Airavata Reference Gateway

Airavata PHP Gateway is set of User Interfaces to demonstrate the core functionalities provided by Airavata. This tutorial provides step-by-step information for obtaining a complete science gateway experience for science and scholarly communities using Airavata as a middleware platform. Here we would also discuss main features and services provided for gateway communities via Airavata.

At the completion of the quick-start-tutorials you would know:

  • Gateway user registration and account verification steps

  • How to create and modify projects

  • How to create, execute and monitor experiments.

  • How to seek assistance, submit issues, provide user feedback,etc...

For more details on Airavata please visit Airavata site

Test/Demo Environment Details

  1. PHP Reference Gateway link;
    https://testdrive.airavata.org
  2. Download application input files from;
    https://cwiki.apache.org/confluence/display/AIRAVATA/XSEDE14+Gateway+Tutorial+Application+Input+Files+and+Parameters 

Tutorial I - Gateway User Account

Create Account

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

  3. Account activation;
    1. The user will receive an email upon creating the account in the provided email box to confirm the account creation is real. User needs to click the link and login to the gateway using the username and password.
    2. When the user account is first created it is not active; user cannot submit jobs to resources. Gateway admin has to activate the user account after validating each user request for a gateway account.
    3. Gateway user will receive account activation email.
    4. If already logged in, the gateway user need to log out and log-in again.

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://testdrive.airavata.org/login

Image II - Login

Password Recovery

  1. Gateway user can recover the forgotten password using '(Forgot Password? Click here)' link below the login page.
  2. User need to provide the username then will receive and URL in the email to add the new password.

Tutorial II - Create & Search Projects

Create Project

  1. 'Projects' within Airavata is simply a grouping for experiments. Every user will have a 'Default Project' which exists when user logs into the gateway for the first time.
  2. To create Projects navigate to ‘Project --> Create’ from the main menu. Enter Project Name (Mandatory) & Project Description (Optional) and Save.
  3. Project creation Screen

    Image II - Create Project

  4. Upon successful creation, the user is directed to Project Summary page.

Browse Projects

  1. Navigation 'Project --> Browse' from the main menu.
  2. Search keys are;
    1. Project Name
    2. Project Description
  3. Browse Project page;

    Image III - Browse Project

  4. After selecting the search by key, the user has to give  a value to search using the selected key. Click on Search.
  5. User can search for all projects by using (*) as a wild character. The * can be used when searching either option; 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. 
  7. In 'Project Summary' all experiments created under the project will be listed.

Image IV - Project Summary


User can click on the experiment ‘Name’ and navigate to ‘Experiment Summary’ page.


Image V - Experiment Summary

Tutorial III - Create & Launch Experiment

Create Experiment

  1.  Navigation to experiment creation page Main Menu --> Experiment --> Create Experiment
  2. Create Experiment Page - Experiment Information

    Image VI - Create Experiment

  3. First enter/select given fields;
    1. Experiment Name (Mandatory)
    2. Experiment Description (Optional)
    3. Project (Select from the available LOV. Latest will be on top; auto selected)
    4. Application (Select from the available LOV)
    and click ‘Continue’. At this point, the user can clear any entered fields by clicking ‘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 or uploading required input 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. If the application is existing in a single resource, it will be the default value)
    3. Queue (a default value will be taken if not changed by the user)
    4. Node Count (If not entered default value will be taken as the input)
    5. Total Core Count (If not entered default value will be taken as the input)
    6. Wall Time Limit (If not entered default value will be taken as the input)
    7. Total Physical Memory (If not entered default value 0 will be taken as the input)
    8. Notifications: Add email address if required to receive job starting and completing notifications from compute resource itself.
      NOTE: For some compute resources, above default values will not be correct. User needs to change the node count in such cases.
  5. Create Experiment - Application Configuration Part

    Image VII - Create Experiment Contd..

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

    Image VIII - Experiment Summary

Launch Experiment

  1. The experiment can be launched using 'Create Experiment' screen. Click  'Save & Launch' button to directly launch the experiment.
  2. If the experiment was just CREATED for a later launch, the user can launch from 'Experiment Summary' Page. For experiments that are 'launchable' 'Launch' button will be enabled in summary page.
    NOTE: Experiments only in CREATED state can be launched.

 

Tutorial IV - Browse Experiments

  1. User can search for experiment created by him/her through
    1. Experiments → Browse
      OR
    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 Browe Experiments search keys are;

    1. Experiment Name

    2. Experiment Description

    3. Application

    4. Creation Time - User can provide 'From Date' and 'To Date'


      Image IX - Browse Experiments

  3. All the experiments of the user will be listed; latest on top. The user can also search using provided keys with partial values, complete values, (*) wildcard. Above search can be narrowed by combining with experiment status as well.

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

  5. Experiment summary can be used to;

    1. Launch experiment - Explained in above Tutorial III

    2. Cancel experiment

    3. Clone experiment

    4. Edit experiment

    5. View experiment data files (Inputs, outputs, archived files)

Tutorial V - Modify, Cancel & Clone Experiments

Modify Experiment

 

  1. Modify experiment by clicking on the edit icon (pencil) next to experiment name (In Browse Experiment, Project Summary) OR by clicking on ‘Edit’ button in Experiment Summary Page.
  2. User can modify all available fields except experiment status, project, application & experiment ID of experiments only in CREATED state.  

 

Image X - Edit Experiment

Cancel Experiment 

  1. To cancel use 'Cancel' button in 'Experiment Summary’ screen.
  2. Experiment with statuses LAUNCHED and EXECUTING can only be canceled.
  3. When canceled, immediately the Experiment status will change to CANCELING.
  4. If the job is already processed in the remote resource (already COMPLETED in the resource) the job will have COMPLETE state and 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. Once canceled, experiments are only available for cloning, cannot resume.

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
  4. User can change existing information (except the Application) in ‘Edit Experiment’ page and save or save & launch.

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 XII - 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 XIII - Got Feedback?

  • No labels