Apache Airavata
PHP Reference gateway is the UI developed by the Airavata team for demonstration purposes and also for interested science communities to work with. This user manual provides step-by-step information on obtaining a complete science gateway experience for science and scholarly communities using Airavata as a middleware platform. In the user manual we would also discuss main features and services provided for gateway communities via Airavata.
User manual will facilitate;
How to create and modify projects
How to register users in PHP reference gateway.
How to create, execute and monitor, etc... experiments.
How to submit issues, user feedback and user request for new applications.
For more details on Airavata please visit Airavata site
Image I - Create Account
Image II - Login
Image IV - Project Summary
Image V - Experiment Summary
To create an experiment click on ‘Create Experiment’ from the main menu. Navigation Experiment --> Create Experiment
Create Experiment Page - Experiment Information
Image VI - Create Experiment
Initially user need to enter/select given fields in order to continue.
Experiment Name (Mandatory)
Experiment Description (Optional)
Project (Select from the available LOV)
Application (Select from the available LOV)
and click on ‘Continue’ button. If user requires to clear any entered fields can click ‘Reset Values’ before continuing.
Then continue entering Application configuration information.
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 validity is not checked by the gateway. User has the responsibility of uploading correct files.
Compute Resource (select from the available LOV)
Node Count (If not entered default value will be taken as the input)
Total Core Count (If not entered default value will be taken as the input)
Wall Time Limit (If not entered default value will be taken as the input)
NOTE:
For values c, d and e if user does not enter, default value will be taken as the input.
For c and d user has to enter a value greater than or equivalent to 1.
For e user has to enter a value greater than or equivalent to 0.
Create Experiment - Application Configuration
Image VII - Create Experiment Contd..
Save the Experiment. Upon successful creation of an experiment, confirmation message will be displayed;
Experiment <Experiment Name> created!
While entering application configurations user can reset just the application configurations using ‘Reset Application Configuration’ button or can start over from the beginning using ‘Start Over’ button.
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 VIII - Experiment Summary
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’.
When an experiment is saved and launched at the same time, two messages will be displayed; Experiment <Experiment Name> created! & Experiment launched!
User can also create and save the experiment to launch later. To launch later user has to navigate to 'Experiment Summary' Page.
If the experiment is not suppose to be launched e.g.: a COMPLETED, LAUNCHED experiment, then the launch button will be disabled.
User can search for experiment created by him/her through
Experiments → Search Experiments
Search Projects → View Project → View Experiment (by clicking on the status of the experiment) - Please refer Search Projects in Tutorial II above.
In Search Experiments search keys are;
Experiment Name
Experiment Description
Application
…
Search Experiments Page
Image IX - Search Experiments
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.
Click on Search once the search key is selected and value is entered.
All the experiments as per entered Key value pair will be listed.
By clicking on the 'Status' user will be navigated to ‘Experiment Summary’ screen of each experiment.
In experiment summary users can;
Launch experiment - Explained in above Tutorial III
Cancel experiment
Clone experiment
Edit experiment
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.
Modify experiment by clicking on the edit icon (pencil) next to experiment name OR by clicking on ‘Edit’ button in Experiment Summary Page.
User can modify all available fields except experiment status, application & experiment ID.
User can update experiments with statuses;
CREATED
CANCELED
FAILED
UNKNOWN
VALIDATED
Edit Experiment Page
Image X - Edit Experiment
Experiments can be canceled by navigating to experiment’s 'Experiment Summary’ screen.
Experiment statuses which allows cancellations;
CREATED
VALIDATED
LAUNCHED
EXECUTING
SCHEDULED
Click on ‘Cancel’ button and on successful cancellation confirmation message will be displayed;
Experiment cancelled!
In Experiment Summary page the experiment status will be CANCELLED or CANCELING.
Experiments can be cloned irrespective of the experiment status by clicking ‘Clone’ in ‘Experiment Summary’ page.
When clicks ‘Clone’ from experiment summary user will be navigated to ‘Edit Experiment’ page of the new experiment. The new experiment will have exact same information as the earlier existing experiment.
The new experiment will have a new experiment ID and the status will always be CREATED.
New experiment name = Clone of + Old experiment name
User can change existing information in ‘Edit Experiment’ page and save or save & launch.
Gateway user can report issues faced within the gateway through this page.
Page navigation: Help → Report Issue
Raise a Bug Page
Image XI - Raise a Bug
Gateway allows users to provide feedback as well as request for new applications via Request Feature Page.
Page Navigation; Help → Request Feature
Got Feedback? Page
Image XII - Got Feedback?