website/manual.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   2 <html xmlns="http://www.w3.org/1999/xhtml">\r
   3 <head>\r
   4 <meta name="Last-modified" content="Mon, 11 Dec 2010 01:03:33 GMT"/>\r
   5 <title>Java Bioinformatics Analyses Web Services (JABAWS) manual - getting started</title>\r
   6 <link href="ws.css" rel="stylesheet" type="text/css" media="screen,  projection, handheld, tv" />\r
   7 <link rel="stylesheet" type="text/css" media="print" href="print.css"/>\r
   8 \r
   9 <script type="text/javascript" src="prototype-1.6.0.3.js"></script>\r
  10 </head>\r
  11 <body>\r
  12 <div id="page">\r
  13 <div id="banner"><table> \r
  14 <tr><td style="width:130px;"><a href="http://www.dundee.ac.uk"><img class="logo" src="images/uod_lt.gif"  alt="University of Dundee"  title="University of Dundee" longdesc="http://www.dundee.ac.uk"/></a></td>\r
  15 <td class="bg"><h1><span class="headeru">JA</span>va <span class=\r
  16 "headeru">B</span>ioinformatics <span class="headeru">A</span>nalysis <span class="headeru">W</span>eb <span\r
  17 class="headeru">S</span>ervices</h1></td>\r
  18 </tr>\r
  19 </table>\r
  20 </div><!-- banner end-->\r
  21 <div id="wrapper">\r
  22 <div id="panel">\r
  23         <a href="index.html">Home</a>\r
  24     <a class="selected" href="manual.html">Manual</a> \r
  25         <div id="submenu">\r
  26                 <a class="selected" href="manual.html">Quick Start Guide</a>\r
  27                 <a href="man_about.html">About</a>\r
  28                 <a href="man_servervm.html" title="JABAWS Server as Virtual Appliance">Server VA</a>\r
  29                 <a href="man_serverwar.html" title="JABAWS Server as Web Application aRchive">Server WAR</a>\r
  30                 <a href="man_configuration.html" >Server<br/>\r
  31                 Configuration</a>\r
  32                 <a href="man_client.html" title="JABAWS Command Line Client">CMD Client</a>\r
  33                 <a href="man_dev.html" title="Accessing JABAWS from your program">Accessing<br/>\r
  34                 JABAWS</a>      \r
  35         </div>\r
  36         <a href="download.html">Download</a>\r
  37         <a href="http://www.compbio.dundee.ac.uk">Barton Group</a></div>\r
  38 <!-- panel end-->\r
  39 <div id="content">\r
  40 \r
  41 <h2 id="headtitle">JABAWS MANUAL</h2>\r
  42 <h2>Quick Start Guide</h2>\r
  43 \r
  44 <h3><a name="whichjaba" id="whichjaba"></a>Choose JABAWS distribution</h3>\r
  45 <p>There are three main packages you could use</p>\r
  46 <ol>\r
  47   <li>A JABAWS Server Virtual Appliance (or Virtual Machine) - for anyone who wants to run JABAWS locally for themselves </li>\r
  48   <li>A JABAWS Server Web Application Archive (WAR) package - for anyone who wants to run JABAWS for their group, lab or organization. Wants to use the cluster or perform very large tasks </li>\r
  49   <li>A client  package - for anyone who wants to use JABAWS from their own code, without Jalview, scripting against local or public version of JABAWS Server. </li>\r
  50 </ol>\r
  51 <p>Virtual Appliance (VA) package (1) contains TurnKey Linux with JABAWS installed. JABAWS VA contains JABAWS WAR deployed on the Apache Tomcat 6 web application server. If you use MS Windows read no further - the VA is the way to go.  You would need to install <a href="http://www.vmware.com/products/player">VMWare Player</a> or <a href="http://www.virtualbox.org/wiki/Downloads">Oracle VirtualBox</a> (both are free) on your computer to use this package.   More details about JABAWS virtual appliance is available from the <a href="man_servervm.html">Server VA</a> section of the manual. </p>\r
  52 <p>Option 2, Web Application Archive package  contains JABAWS ready to be deployed on the Servlet 2.4 compatible web application server such as Apache Tomcat version 6.  To make this version work you would need </p>\r
  53 <ol>\r
  54   <li>Install Apache-Tomcat or similar web application server. </li>\r
  55   <li>If you are not on Linux, you would have to make binaries for your system available to JABAWS.  </li>\r
  56   </ol>\r
  57 <p>Read more on <a href="man_serverwar.html">JABAWS WAR in the manual</a>. </p>\r
  58 <p>A client only package (3) contains the JABAWS command line client. It functionality is equivalent to that of Jalview .  This is the package for anyone who wants to connect to and to use JABAWS from their own software. Read more about how to use command line client <a href="#cmdclient">in the CMD Client</a> section of the manual. Also, JABA Web Services are fully WS-I compliant, so one could use any language to access them.  </p>\r
  59 <p><strong>If you chose option 1 </strong></p>\r
  60 <p>and you work on Windows or Linux or Unix </p>\r
  61 <ul>\r
  62   <li>download and install VMWare Player </li>\r
  63   <li>Download JABAWS Virtual Appliance </li>\r
  64   <li>Unpack JABAWS virtual appliance and open it with VMware Player. </li>\r
  65   </ul>\r
  66 <p>otherwise </p>\r
  67 <ul>\r
  68   <li>download and install Virtual Box.  </li>\r
  69   <li>Download JABAWS Virtual Appliance </li>\r
  70   <li>Unpack JABAWS virtual appliance, import it into VirtualBox and then start the appliance. </li>\r
  71   </ul>\r
  72 <p><strong>If you chose option 2 </strong></p>\r
  73 <p>If you are on Linux or Windows </p>\r
  74 <ol><li>Download JABAWS WAR </li>\r
  75   <li>Download and install <a href="http://tomcat.apache.org/download-60.cgi">Apache-Tomcat</a> </li>\r
  76   <li>Drop the JABAWS war file into<span class="hightlight"> tomcat/webapps</span> directory. </li>\r
  77   <li>If you are on Linux, <span class="hightlight">cd</span> to <span class="hightlight"> webapps/jabaws/binaries/src/</span> and execute <span class="hightlight">./setexecflag.sh </span> script to set an executable flag for JABAWS binaries. </li>\r
  78   <li>Restart the Tomcat </li>\r
  79 </ol>\r
  80 <p>otherwise</p>\r
  81 <ul>\r
  82   <li>Complete  steps 1-3 from the above.</li>\r
  83   <li> <span class="hightlight">cd</span> to <span class="hightlight">webapps/jabaws/binaries/src/</span> and execute <span class="hightlight">./compilebin.sh  </span> script to compile all binaries JABAWS depends on. </li>\r
  84   <li><span class="hightlight">cd</span> to <span class="hightlight"> webapps/jabaws/binaries/src/ </span>and execute <span class="hightlight">./setexecflag.sh </span> script. </li>\r
  85   <li>Restart the Tomcat </li>\r
  86 </ul>\r
  87 <p>Once you have JABAWS working you can point  the Jalview  to your local JABAWS. </p>\r
  88 <ul>\r
  89   <li>Download and start the desktop version of <a href="http://www.jalview.org/Web_Installers/install.htm">Jalview</a> </li>\r
  90   <li>Go to Jalview-&gt;Tools-&gt;Preferences-&gt;Webservices-&gt;New Service URL and enter the JABAWS URL which you can see one your appliance is booted up. </li>\r
  91 </ul>\r
  92 <p><strong>if you chose option 3</strong> </p>\r
  93 <p>You can use the client straight out of the box. </p>\r
  94 </div> \r
  95 <!-- about end-->\r
  96 </div>\r
  97 <!-- content end--> \r
  98 <div id="copyright">Last update: 7 January 2011<br/>\r
  99 Peter Troshin and Geoff Barton, The Barton Group, University of Dundee, UK</div>\r
 100 </div><!-- wrapper end-->\r
 101 </div> <!-- page end-->\r
 102 \r
 103 <!-- Google analitics -->\r
 104 <script type="text/javascript">\r
 105 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");\r
 106 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));\r
 107 </script>\r
 108 <script type="text/javascript">\r
 109 try{\r
 110 var pageTracker = _gat._getTracker("UA-5356328-1");\r
 111 pageTracker._trackPageview();\r
 112 } catch(err) {}\r
 113 </script>\r
 114 </body>\r
 115 </html>\r
 116 \r