Apache Airavata

 

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 I - Gateway Login

Create Account
  1. New user has to create the account using ‘Create account’ link on top right hand corner of the gateway top banner. 
    To create an account;
    1. Please enter User information and submit. A confirmation message will confirm the creation.
      NOTE: Username cannot have spaces
                  Username & password must be longer than 5 characters.
                  password is case sensitive
    2. Enter all the mandatory fields indicated by a star; *.
    3. Account creation link
      http://test-drive.airavata.org/PHP-Reference-Gateway/create_account.php
Login to Account
  1. Once the account is created successfully; login to the gateway using the created account. 
    Gateway login screen link 
    http://test-drive.airavata.org/PHP-Reference-Gateway/login.php
    OR
  2. use the 'Log In' link given on the 'Create New Account' page after account retain is successful.

Tutorial II - Create Projects

  1. To create Projects navigate to ‘Create project’ screen. Enter Project Name (Mandatory) & Project Description (Optional) and Save. 
    Screen Link
    http://test-drive.airavata.org/PHP-Reference-Gateway/create_project.php
  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 III - Create & Launch Experiment

Create Experiment
  1. To create an experiment click on link ‘Create Experiment’ from the title bar. 
    Screen Link 
    http://test-drive.airavata.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 (Projects created by the logged in user will be listed for selection)
    3. Application (Applications available will be listed for selection)
    4. Experiment Input - Depending on the application user can either enter input data or upload files.
      Echo application - Input data is entered as text
      WRF application - Input data uploaded as files. User can either upload a single file or multiple files; all depends on the application.
    Advance (Optional) Fields
    Select the resource to run the application. If user doesn’t select one the application will be executed with default values for the resource.
    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. Experiment infomration is captured in two stages; Once click on 'Continue' button user cannot change values entered for
    1. Experiment Name - If blank when clicking 'Continue' a message will be prompted.
    2. Experiment Description
    3. Project - Project selected will be saved if user didn't select one from the provided list.
    4. Application - Application selected will be saved if user didn't select one from the provided list.
  4. Save the Experiment. Upon successful creation of an experiment, confirmation message will be displayed; Experiment <Experiment Name> created! 
  5. 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 ‘Experiment Summary’ screen of the selected experiment. 
     E.g.: http://gw120.iu.xsede.org/PHP-Reference-Gateway/experiment_summary.php?expId=Test_E_1_bafffa2e-654d-4a45-938a-6fb2c8bc6600
  6. To launch click on ‘Launch’ button; A confirmation message will be displayed when successfully launched; Experiment launched!  
  7. If the experiment is not suppose to be launched e.g.: a COMPLETED experiment then the Launch button will be disabled.

Tutorial IV - 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. To edit/update the experiment user can click on the icon next to experiment name.
  3. By clicking ‘Details’ user will be navigated to ‘Experiment Summary’ screen of each experiment.
  4. In experiment summary users can;
    1. Launch experiment - Explained in above Tutorial III
    2. Cancel experiment
    3. Clone experiment
Edit/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 'Experiment Summary’ 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 ‘Experiment Summary’ 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 V - Search Experiments

  1. User can search for experiment created by him/her using screen http://gw120.iu.xsede.org/PHP-Reference-Gateway/search_experiments.php
  2. Search keys are;
    1. Experiment Name
    2. Experiment Description
    3. Application
  3. After selecting the search by key, user has to give  a value to search for using the key. Partial values, complete values, wild cards can be sued for search
  4. Click on Search once the search key is selected and value is entered.
  5. All the Experiments as per entered Key value pair will be listed.

Tutorial VI - Search Projects

  1. Similar to searching experiments user can search for existing projects created by him/her using screen http://gw120.iu.xsede.org/PHP-Reference-Gateway/search_projects.php
  2. Search keys are;
    1. Project Name
    2. Project Description 
  3. After selecting the search by key, user has to give  a value to search for using the key.
  4. Click on Search once the search key is selected and value is entered.
  5. All the Projects as per entered Key value pair will be listed.
  • No labels

For an overview of Apache Airavata visit the Website - https://airavata.apache.org/