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... experiment.
  • Reporting issues and user feedback/user request for new applications.


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 & Search Projects

Create Project
  1. To create Projects navigate to ‘Project --> Create project’ from the menu. 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!
 Search Projects 
  1. To search for existing projects created by him/her using screen http://test-drive.airavata.org/PHP-Reference-Gateway/search_projects.php
  2. Screen navigation 'Project --> Search Projects' from the menu bar.
  3. Search keys are;
    1. Project Name
    2. Project Description 
  4. After selecting the search by key, user has to give  a value to search for using the key.
  5. Click on Search once the search key is selected and value is entered.
  6. All the Projects as per entered Key value pair will be listed.
  7. User can search for all projects created by using (*).
  8. Experiments created under each project also gets listed; user can click on the experiment status and navigate to Experiment Summery page.

Tutorial III - Create & Launch Experiment

Create Experiment
  1. To create an experiment click on ‘Create Experiment’ from the menu bar. Navigation Experiment --> Create Experiment 
    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/Amber application - Input data uploaded as files. User can either upload a single file or multiple files; all depends on the application.
    5. Compute Resource
    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. Node Count
    2. Total CPU Count
    3. Number of Threads
    4. Wall Time Limit
    5. 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. User can also create and save an experiment and launch later. To launch later user has to first search for the experiment and navigate to 'Experiment Summery' Page. 
  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. To launch click on ‘Launch’ button; A confirmation message will be displayed when successfully launched; Experiment launched!  
  6. If the experiment is not suppose to be launched e.g.: a COMPLETED experiment, then the Launch button will be disabled.

Tutorial IV - Search Experiments

  1. User can search for experiment created by him/her using screen http://test-drive.airavata.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 card can be used to 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.
  6. By clicking on the 'Status' user will be navigated to ‘Experiment Summary’ screen of each experiment.
  7. In experiment summary users can;
    1. Launch experiment - Explained in above Tutorial III
    2. Cancel experiment
    3. Clone experiment
    4. Edit experiment
  8. User can edit an experiment by navigating to 'Edit Experiment' page. Edit button next to each experiment name will navigate user to 'Edit Experiment' page of each experiment.
  9. Experiment Summery Page

    Image - Experiment Summery Page
Edit/Update Experiment
  1. Can edit experiment by clicking on the edit icon next to experiment name OR by clicking on edit button in Experiment Summery Page.
  2. User can modify all available fields except for the Experiment status, Application & 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 Experiment Summery page 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 - Help

Report Issue
  1. Gateway user can report issues faced within the gateway through Report Issue page.
  2. Page navigation: Help --> Report Issue
Request Fature
  1. Gateway allows users to provide feedback as well as request for application via Request Feature Page.
  2. Page Navigation; Help --> Request Feature


  • No labels

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