Page History

...

1. Get Airavata Version 
   Execute php getAPIVersion.php and confirm the Airavata API version.

Tutorial III -

...

1. To add computational resources use script; registerComputeResource.php
2. In order to run the script hostName and resourceDescription are passed as command line arguments.
   1. Format;
      php registerComputeResource.php<space><hostName><space><resourceDescription>
3. Execute the above and a confirmation message will be prompted along with the resource ID (computResourceId)
   Compute Resource<space><computeResourceId><space>is<space>registered!
4. Tutorial Tryout;
   Add other parameters to the script as command line arguments and improve the script.
   1. hostAliases

   2. ipAddresses

...

Create, Update & List Projects

Create Project

1. Use; createProject.php to create new projects.
   project_owner and project_name can be given as command line arguments.
   1. Format;
      php createProject.php<space><project_owner><space><project_name>
2. When creating new projects both project_owner and project_name cannot contain spaces.
   1. Sample values;
      project_owner: Thomas   
      project_name: Test_Project
3. Successful creation of project will give confirmation message with the Project ID 
   Project<space><project_ID><space>is<space>created! 
4. Tutorial tryout; 
   Add project description as a command-line argument to the existing createProject.php script and execute.
   
   

...

Image - Project Detail Listing

Tutorial

...

IV - Create, View , Update & Clone Experiment

Create Experiment

1. Create an experiment with above created project using createExperiment.php script. When creating experiment User, Experiment name and Project ID (username, experiment_name, project_ID) are passed as arguments to the script.
   1. Format;
      php createExperiment.php<space><username><space><experiment_name><space><project_ID>
2. Changing other parameters require opening the script and modifying and saving values inside the script. 
   Sample values;
   

    

   Parameter	Sample Values	NOTE
   Project ID	Test_Project_4063b440-332a-49af-a6de-aea21d77bb2f	Project iD is validated against existing projects Passed as an argument to the script
   Creating User	Thomas	Users are validated against existing Airavata gateway users. Passed as an argument to the script
   Experiment Name	Exp_Test_Project_1	Not a unique value. Use can enter any value Passed as an argument to the script
   Resource Host ID	trestles.sdsc.edu stampede.tacc.xsede.org
   Computational Project Account
   Total CPU Count	10	Number of CPUs required for the experiment
   nodeCount	10	Number of nodes required in each CPU
   Number of Threads	10	Number of threads per node
   Queue Name	normal	if left blank it will pick default queue
   Wall Time Limit	10	This is given in minutes
   JobStartTime	0
   Total Physical Memory	0
   Application ID	SimpleEcho2	Existing application in the selected resource
   Input Key	echo_input
   Input Value	echo_output=Hello World
   Output Key	echo_output

3. Depending on the computational resource used the resource scheduling data part need to be entered by the user. Other defined resource scheduling parts should be commented. 
   
   
   Image - PHP Script Sample
   
   
4. Execute the file; experiment will be created and experiment ID will be generated; ID is the unique value which identifies the experiment in Airavata.
5. Experiment creation confirmation message;
   Experiment<space><exp_ID><space>created!

...

1. To clone above modified experiment use cloneExperiment.php.
2. Cloning will create exact copy of the existing experiment with a new experiment ID in CREATED state. 
3. To clone the experiment use;
   1. php cloneExperiment.php
   2. Format:
      php cloneExperiment.php<space><exp_ID>
4. Experiment modification confirmation message;
   1. Experiment<space><exp_ID><space>cloned!
5. User can clone any experiment created by him/her irrespective of the experiment status.
6. User can change existing information by updating the newly created experiment.
7. Tutorial tryout;
   1. Try adding parameters to the script to change other data in the new experiment. E.g.: Exp name, Application, Resource, etc… and execute.

Tutorial

...

V - Search Experiments

Get All Experiments In Project

...

1. Experiments can be searched by providing username along with applicationId or part of the applicationId.
   1. Format;
      php search_experiments_by_application.php<space><username><space><applicationID>
   2. Example;
      php search_experiments_by_application.php Test_User Echo
2. When the script is executed; all the experiments which has the given text as part of the application ID will be listed along with all experiment information.

Tutorial

...

VI - Launch & Cancel Experiments

Launch Experiment

1. launchExperiment.php is used to launch individual experiments. 
2. Currently with the scripts to launch an experiment user need to pass only the experiment ID as a command line arguments to the script.
   1. Format;
   2. php launchExperiment.php<space><experiment_id>
3. Upon successful launch a confirmation message will be displayed; 
   Experiment<space><experiment_id><space>is<space>launched!     

...

1. Experiments which are not in statuses COMPLETED, CANCELED, UNKNOWN can be canceled/terminated. 
2. In order to cancel use;
   1. Format;
      php terminateExperiment.php<space><Experiment ID>
3. User provided with the message; 'If there are no exceptions, assume the experiment terminated successfully'
4. Experiment will be terminated/canceled. The status can be viewed by using the command getExperimentStatus.php. Status will be  immediately changed to CANCELING and then to CANCELED.

Tutorial

...

VII - Get Experiment Results & Status

  Check Experiment Status

...

1. Once the experiment is COMPLETED (Status of the experiment is checked using above getExperimentStatus.php) user can check the output. 
2. To check the output  
   1. Format; 
      php getExperimentOutputs.php<space><experiment_id>

Image - Sample output

Tutorial VIII - Add Computational Resources

1. To add computational resources use script; registerComputeResource.php
2. In order to run the script hostName and resourceDescription are passed as command line arguments.
   1. Format;
      php registerComputeResource.php<space><hostName><space><resourceDescription>
3. Execute the above and a confirmation message will be prompted along with the resource ID (computResourceId)
   Compute Resource<space><computeResourceId><space>is<space>registered!
4. Tutorial Tryout;
   Add other parameters to the script as command line arguments and improve the script.
   1. hostAliases

   2. ipAddresses

Tutorial IX - List Applications

...