Table of Contents

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 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.

...

1. PHP Reference Gateway link;
   https://testdrive.airavata.org
2. Download application input files from;
   Generic sample application inputs 
   Sample application inputs for Gaussian and Gamess

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 address to confirm the account creation. The user needs to use the link in the email and provide the gateway username and password.
   2. When the user account is first created it is not active; the user cannot submit jobs to resources. Gateway admin has to activate the user account after validating each user request for a gateway account.
   3. If the account confirmation fails, please contact you gateway admin through the Contact us.
   4. Gateway user will receive an email notifying change of privileges in the gateway when the account is active.
   5. If already logged in, the gateway user needs to log out and log-in again.

Login to Account

1. Once the account is created successfully; log in 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 in the login page.
2. The user needs to provide the username then will receive an URL to add the new password.

Tutorial II - Create & Search Projects

Create Project

1. A Project is simply a grouping for experiments. Every user will have a 'Default Project' which exists when the user logs into the gateway for the first time.
2. Projects are also used to share with other gateway users. e.g.: Sharign Sharing a project with another user will give him access to all his experiments in the project.
3. To create Projects navigate to ‘Project --> Create’ from the main menu. Enter Project Name (Mandatory) & Project Description (Optional) and Save.
4. Project creation Screen
   Image Modified
   Image II - Create Project
5. 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. The user can search for projects by using (*) as a wild character. The * can be used when searching either option; Project name or description.
5. When projects are listed by clicking ‘View’ at the end of the row user can navigate to ‘Project Summary’ page. 
6. In 'Project Summary' all experiments created under the project will be listed.

...

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

...