Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PHP Reference gateway is the interface developed by the Airavata team for demonstration purposes and also for interested science communities to work with. This guide provides step-by-step information on obtaining a complete science gateway experience for science and scholarly communities using Airavata as a middleware platform. Here we also discuss main features and services provided for gateway communities via Airavata.

End of the tutorial you will know;

  • How to create and activate user account in the gateway.

  • How to create and modify projects

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

  • How to communicate your issues, feedback, and request.

For more details on Airavata please visit Airavata site

...

  1. Create a user account using 'Create Account' in on the home page.
    1. Account creation page link:https://testdrive.airavata.org/create
    2. Please enter required information and submit.
    3. Important;
      1. Username cannot have spaces.
      2. Username cannot be an email address.
      3. Username & password must be longer than 5 characters.
      4. The password is case sensitive.
      5. All the mandatory fields indicated by a star; *.

  2. Account activation;
    1. The user will receive an email upon creating the account to provided email to confirm the creation. Follow the instructions and login to the gateway using the username and password.
    2. Once the account is confirmed gateway admin has to provide gateway access after validating the user account.
    3. The user will be notified gateway access via email.
       

...

  1. 'Projects' in the gateway is simply a grouping of experiments. 
  2. Every user will have a pre-created 'Default Project'.
  3. To create Projects navigate to ‘Project → Create’ from the main menu. EMandatory fields indicated by star; *.
  4. The user is directed to Project Summary page upon successful creation of the project.

Search Projects

  1. Screen navigation To browse existing projects, 'Project --> Browse  Browse' from the main menu.
  2. Search keys are;
    1. Project Name
    2. Project Description
    Search Project Page;
    Image Removed
    Image III - Search Project
  3. After selecting the search by key, user the user has to give  a value to search using the selected key. Click on Search.
  4. All the Projects as per entered key value pair will be listed .
  5. User can search for all projects by using (*) as a wild character. The * can be used when searching either options; Project name or description.
  6. When projects are listed by with pagination. By clicking ‘View’ at the end of the row user can navigate to ‘Project Summary’ page. 

Image Removed

Image IV - Browse Projects

All experiments created under the project will be listed

Image Removed

Image V - Project Summary

...

  1. The user can also search using (*) as a wild character. 
  2. Using 'View' link i each project user can view all the experiments grouped under the project.From project browse page, the user can 
  3. User can click on the experiment

...

  1. ‘Name’ and navigate to ‘Experiment Summary’ page

...

Image Removed

...

  1. of the selected experiment.

Tutorial III - Create & Launch Experiment

Create Experiment

  1. To create an experiment click on ‘Create Experiment’ navigate to Experiment  Create from the main menu. Navigation Experiment --> Create ExperimentCreate Experiment Page - Experiment Information
    Screen Shot 2014-09-08 at 1.59.12 PM.pngImage Removed
    Image VII - Create Experiment
  2. Create experiment page is filled in two stages.
  3. Initially, Initially user needs to enter/select given fields in order to continue.
    1. Experiment Name (Mandatory)
    2. Experiment Description (Optional)
    3. Project (Select from the available LOV)
    4. Application (Select from the available LOV)
    and click on ‘Continue’ button. At this point, user can clear any entered fields the user can restart 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 manually or uploading a single or multiple files.
      NOTE: Uploading file content validity is not checked by the gateway. User The 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 the default value 0 will be taken as the input)
    NOTE:
  5. For values some compute resources default values in d, e and f if user does not enter,  default value will be taken as the input. For some compute resources, this default value will not be correct. User , in such cases the user needs to change the node count in such cases.
  6. For d and e user has to enter a value greater than or equivalent to 1.
  7. For f user has to enter a value greater than or equivalent to 0.
  8. Create Experiment - Application Configuration Part
    Image Removed
    Image VIII - Create Experiment Contd..
  9. While entering application configurations user can start over from the beginning using ‘Start Over’ button.
  10. Once saved or saved and launched user will be directed to ‘Experiment Summary’ page; can refresh the page and monitor experiment status changes.Experiment Summary Page
    Image Removed
    Image IX - Experiment Summary

Launch Experiment

    To
  1. The user can launch an experiment
  2. can use the same
  3. in 'Create Experiment
  4. ' screen. Apart from saving the experiment user can Save & Launch at the same time using button ‘Save and Launch’.
  5. ' page by selecting 'Save and Launch'. 
  6. User can also create and save the experiment to launch later
  7. . To launch later user has to navigate to
  8. from 'Experiment Summary' Page
  9. Experiments can be accessed through 'Experiment → Browse' or 'Project →Browse →View Project' pages.
  10. If the experiment is not supposed to launch e.g.: a COMPLETED, LAUNCHED experiment, then the launch button will be disabled.

Tutorial IV - Browse Experiments

  1. User can search for experiment created by him/her through

    1. Experiments → Browse

    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 Search Experiments search keys are;

    1. Experiment Name

    2. Experiment Description

    3. Application

  3. Browse Experiments Page

...