PHP Reference Gateway Tutorial - Building a Science Gateway Experience

Introduction

This tutorial provides step-by-step information on building a complete science gateway experience for science and scholarly communities using Airavata as a middle-ware platform. As we progress with the tutorial we would also discuss main features and services provided for gateway communities via Airavata.

At the the end of the tutorial you will know;

• Available options for using PHP reference gateway and Airavata.

• How to setup the PHP reference gateway and Airavata environment; configuring PHP reference gateway and Airavata.

• how to register users in PHP reference gateway.

• How to create, execute and monitor, etc... experiments

For more details on Airavata please visit Airavata site

Tutorial 01 - Gateway Login

1. Create Account
   New user has to create the account using ‘Create an account’ link on top right hand corner of the gateway top banner.
   To create an account;
   1. Enter Username & Password and submit. A confirmation message will confirm the creation.
      NOTE: Username cannot have spaces
      Username & password must be longer than <?> characters.
      password is case sensitive
   2. Account creation link
      http://gw120.iu.xsede.org/PHP-Reference-Gateway/create_account.php
      
      
2. Login using created account 
   Once the account is created successfully login to the gateway using the created account. 
   Gateway login screen link 
   http://gw120.iu.xsede.org/PHP-Reference-Gateway/login.php

Tutorial 02 - Create Projects

1. To create Projects navigate to ‘Create project’ screen. Enter Project Name (Mandatory) & Project Description (Optional) and Save. 
2. Prior to submission, fields can be cleared using Clear button. 
3. Successful creation of projects will be confirmed by confirmation message; 
   Project <Project Name> created!

Tutorial 03 - Create & Launch Experiment

Create Experiment

1. To create an experiment click on link ‘Create Experiment’ from the title bar. 
   Screen Link 
   http://gw120.iu.xsede.org/PHP-Reference-Gateway/create_experiment.php 
2. To create an experiment please enter information into fields as per directed.
   Mandatory fields
   1. Experiment Name
   2. Project
   3. Application (Application created by the logged in user will be listed for selection)
   4. Experiment Input
   Advance (Optional) Fields
   Select the resource to run the application. If user doesn’t select one the application will be executed in the default resources.
   1. Compute Resource
   2. Node Count
   3. Total CPU Count
   4. Number of Threads
   5. Wall Time Limit
   6. Total Physical Memory
   Other Optional Fields
   1. Experiment Description
3. Save the Experiment. Upon successful creation of an experiment, confirmation message will be displayed; Experiment <Experiment Name> created! 
4. While entering field values the screen can be cleared using ‘Reset values’ button. 

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. When an experiment is saved and launched at the same time, two messages will be displayed; Experiment <Experiment Name> created! & Experiment launched!  
3. To launch a previously created experiment user has to use ‘Browse Experiments’ screen 
   http://gw120.iu.xsede.org/PHP-Reference-Gateway/browse_experiments.php 
4. In ‘Browse experiments’ all the projects created by the logged in user will be listed along with any existing experiments for each project.  
5. By clicking ‘Details’ link of each experiment use can navigate to the ‘Manage Experiment’ screen of the selected experiment. 
   http://gw120.iu.xsede.org/PHP-Reference-Gateway/manage_experiment.php?expId=ExpTest002_b63fe099-13df-4ca0-a73d-3a673739a1cb 
6. To launch click on ‘Launch’ button; A confirmation message will be displayed when successfully launched; Experiment launched!  
7. User can modify the experiment and launch at the same time by clicking Launch button in the Manage experiment screen.

Tutorial 04 - Browse Experiments

1. In the screen all the projects created by the logged in user will be listed along with the experiment created with each project.
   http://gw120.iu.xsede.org/PHP-Reference-Gateway/browse_experiments.php
2. User can view details by clicking ‘Details’ link of each experiment.
3. By clicking ‘Details’ usr will be navigated to ‘Manage experiments’ screen of each experiment.
4. In manage experiments users can;
   1. Update experiment
   2. Cancel experiment
   3. Clone experiment

Update Experiment

1. Go to ‘Browse Experiments’ screen and select the experiment which require modification(s). 
2. User can modify all available fields except for the Experiment status & Experiment ID.  
3. User can update experiments with statuses; 
   1. CREATED 
   2. CANCELED  
   3. FAILED 
   4. UNKNOWN  
   5. VALIDATED

Cancel Experiment

1. Experiments can be canceled by navigating to experiment’s ‘Manage experiment’ screen. 
2. Experiment statuses which allows cancellations;
   1. CREATED
   2. VALIDATED
   3. LAUNCHED
   4. EXECUTING
   5. SCHEDULED
3. Click on Cancel button and on successful cancellation confirmation message will be displayed; Experiment cancelled! In Browse experiments screen the experiment status will be CANCELLED or CANCELING.
    

Clone Experiment

1. Experiments can be cloned irrespective of the experiment status by clicking ‘Clone’ in ‘Manage experiment’ window. 
2. When cloned 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 be CREATED. 
4. User can change existing information by updating the newly created experiment.

Tutorial 05 - Search Experiments