Tutorial 08 - XBAYA Quick-Start

Airavata XBAYA Quick Start Up Tutorial - OBSOLETE

Prerequisites 

1. Requires RabbitMQ server running in our local machine.
   1. Download the RabbitMQ from https://www.rabbitmq.com/install-standalone-mac.html.
   2. Unzip the downloaded RabbitMQ tar file into a folder in your local machine. To unzip use;
      tar -xvf rabbitmq-server-mac-standalone-3.4.1.tar.gz
   3. Start the RabbitMQ server using;
      ./rabbitmq_server-3.4.1/sbin/rabbitmq-server –detached
      (For detailed information on getting RabbitMQ started, stooped, etc please visit https://www.rabbitmq.com/download.html)
2. Requires maven (java based code building tool)
   1. http://maven.apache.org/download.cgi
   2. http://maven.apache.org/download.cgi#Installation

Start Airavata Server & XBAYA

1. Clone the source (If you have not taken a clone prior) code from github (git clone https://github.com/apache/airavata). If you have already cloned go to next step.
2. In your machine go to local folder where Airavata source code is cloned and then do a git pull to make sure you have the latest trunk.
3. After the above is completed build the source code by executing following maven command;
   mvn clean install
   (Useful Hint: Use mvn clean install -Dmaven.test.skip=true to avoid tests and is recommended for first timers.)
4. Go to folder where Airavata server distribution zip or tar files are residing.
   cd modules/distribution/server/target
5. Unzip either the tar or zip file of Airavata server distribution using
   unzip apache-airavata-server-0.14-SNAPSHOT-bin.zip
   OR
   tar -xvf apache-airavata-server-0.14-SNAPSHOT-bin.tar.gz
6. Go to extracted folder
   cd apache-airavata-server-0.14-SNAPSHOT
7. In folder apache-airavata-server-0.14-SNAPSHOT navigate to the bin and view the file airavata-server.properties
8. Update ‘pubilsh.rabbitmq’ property to true in bin/airavata-server.properties file. File would then have;
   publish.rabbitmq=true
9. In bin start the Airavata server; 
   (Useful Hint:This may require JAVA_HOME to be defined. Some configurations such as in  bin/zoo.cfg and bin/airavata-server.properties  may have to be adjusted if some ports are already in use. Ports need to be open as well.)
   sh airavata-server.sh (This will run the airavata server in the background in demon mode).
   
   If you are in the target folder use given to start Airavata server;
   sh apache-airavata-server-0.14-SNAPSHOT/bin/airavata-server.sh start
   
10. Go to apache-airavata-server-0.14-SNAPSHOT/samples/ directory and register sample scripts and local host. by running 
    sh registerSample.sh  
    NOTE: Running above again will result duplication of Applications in database; Multiple applications will appear in the XBaya GUI. 
11. After starting the AIravata server and registering the sample applications, start XBAYA GUI. Change directory to XBaya Client source, cd modules/distribution/xbaya-gui/ and build xbaya
    mvn clean install
12. Navigate to folder ‘target’ and then extract the xbaya using
    unzip apache-airavata-xbaya-gui-0.14-SNAPSHOT-bin.zip
    OR
    tar -xvf airavata-xbaya-gui-0.14-SNAPSHOT-bin.tar.gz
    
13. Go to bin folder in unzipped apache-airavata-xbaya-gui-0.14-SNAPSHOT and start xbaya GUI
    sh xbaya-gui.sh

Using XBAYA GUI

1. In XBAYA GUI first register the applications by connecting to the Applications registry. Navigation : Registry → Setup Airavata Registry (Image I) and 

   1. Click OK (to use the default values) on the pop up window (Image II).

   
   Image I
   
   
   Image II
   
   
2. All available sample applications will get listed in the left hand upper corner ‘Component List’ window under Applications component.
   
   Image III
   
   
3. Click on ‘New’ icon (circled in red) to create a new Workflow (or navigate Main Menu → XBaya → New Workflow). Then the ‘Workflow Properties’ window will pop-up. Enter Name and Description and click OK.
   
   Image IV
   
   
4. Select a preferable application from 'Component List' and drag and drop in to the workspace in middle. In this case lets select “Add’ application.
   1. Drag and drop ‘Add; in to the workspace in middle.
   2. Double click on the blue triangles in left hand side of 'Add' component, which will expand the parameter (X and Y) value configuration widgets for the  ‘Add’ application.
      
      Image V
      
      
   3. Click on the ‘Config’ button on each x and y parameter widgets and enter Information if required (OR can execute with the default values as well). Image VI shows configuration for input value ‘x’.
      
      Image VI. 
      
      
5. Double click on the green triangle on the right side of the Add widget to expand the Results widget.  
   
   
6. Click on RUN icon (▶) or select Run from main menu bar (circled in red in Image VII). Launch Window will open, enter experiment name, change the X and Y (if desired)  and select a Host (leave the default ‘localhost’). Click ‘Run’ button (circled in green in Image VII).
   
   Image VII
   
   
7. After experiment is completed view results from the ‘tmp’ folder in your local machine using the experiment ID.
   1. Hint: When the experiment is completed the Results box will be highlighted green.
   2. Temporary folder ‘tmp’ is in the root folder of your local machine. Go to tmp folder; cd /tmp
      
   3. To obtain the exp ID of your experiment double click on the COMPLETED status at the bottom of your xbaya GUI. Copy the Exp ID from the Message box.
      Image VIII 
      
      
8. In the ‘tmp’ folder select the folder named by the executed Exp ID. In the folder view Add.stdout (<Application Name>.stdout) file for the result.