website/man_about.html

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE html PUBLIC "XHTML 1.0 Strict"\r
   3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   4 <html xmlns="http://www.w3.org/1999/xhtml">\r
   5 \r
   6 <head>\r
   7 <meta name="Last-modified" content="Fri, 28 Jun 2013 12:00:00 GMT"/>\r
   8 <title>Java Bioinformatics Analyses Web Services (JABAWS) Server Virtual Appliance Manual</title>\r
   9 <link href="ws.css" rel="stylesheet" type="text/css" media="screen, projection,handheld,tv" />\r
  10 <link rel="stylesheet" type="text/css" media="print" href="print.css" />\r
  11 <script type="text/javascript" src="prototype-1.6.0.3.js"></script>\r
  12 </head>\r
  13 \r
  14 <body>\r
  15 <div id="page">\r
  16 \r
  17 <div id="banner">\r
  18 <table>\r
  19   <tr>\r
  20     <td style="width:158px;"><a href="http://www.dundee.ac.uk"><img src="images/uod_lt_long.gif" width="158" height="90" alt="University of Dundee" class="logo" title="University of Dundee" longdesc="http://www.dundee.ac.uk"/></a></td>\r
  21     <td class="bg"><img src="images/jabaws25.png" width="263" height="60" alt="JABAWS-2.5" title="Java Bioinformatics Analysis Web Services version 2.5"/></td>\r
  22     <td class="bg"><img src="images/banner_right.png" alt="Disorder" width="200" height="80"/></td>\r
  23   </tr>\r
  24 </table>\r
  25 </div>\r
  26 <!-- banner end-->\r
  27 \r
  28 \r
  29 <div id="wrapper">\r
  30 <div id="panel"><a href="index.html">Home</a> \r
  31   <a href="quick_start.html">Getting Started</a> \r
  32   <a class="selected" href="man_about.html">Manual</a> \r
  33   <div id="submenu">\r
  34       <a class="selected" href="man_about.html">About</a>\r
  35       <a href="man_servervm.html" title="JABAWS Server as Virtual Appliance">Server VA</a>\r
  36       <a href="man_awscloud.html" title="JABAWS Server in the Amazon EC2 Cloud">Server in the Cloud</a>\r
  37       <a href="man_serverwar.html" title="JABAWS Server as Web Application aRchive">Server WAR</a>\r
  38       <a href="man_configuration.html" >Server Configuration</a>\r
  39       <a href="man_client.html" title="JABAWS Command Line Client">CMD Client</a>\r
  40       <a href="man_stats.html" title="JABAWS Usage Statistics">Usage Statistics</a>\r
  41       <a href="man_dev.html" title="Accessing JABAWS from your program">Accessing JABAWS</a>\r
  42       <a href="man_server_dev.html" >JABAWS Development</a>\r
  43   </div>\r
  44   <a href="http://www.compbio.dundee.ac.uk/download">Download</a> \r
  45   <a href="PublicAnnualStat" title="JABAWS usage statistics">Usage Statistics</a>\r
  46   <a href="ServiceStatus" title="JABAWS webservices status. Click to test all web services. Please be patient while the services are being checked">Services Status</a>\r
  47   <a href="contacts.html">Contact Us</a>\r
  48   <a href="http://www.compbio.dundee.ac.uk" title="University of Dundee, The Barton Group" >Barton Group</a>\r
  49   <a href="jabaws_funding.html">Funding</a>\r
  50 </div>\r
  51 <!-- panel end-->\r
  52 \r
  53 \r
  54 <div id="content">\r
  55 <h2 id="headtitle">JABAWS MANUAL</h2>\r
  56 <h2>About</h2>\r
  57 \r
  58 <ul>\r
  59   <li><a href="#wisjaba">What is JABAWS?</a></li>\r
  60   <li><a href="#wjaba">JABAWS Benefits</a></li>\r
  61   <li><a href="#alprog">JABA Web Services Programs </a></li>\r
  62   <li><a href="#jaba2.5">What is new in JABAWS 2?</a> </li>\r
  63   <li><a href="#jabaclient">What is JABAWS Client</a>?</li>\r
  64   <li><a href="#jalviewsup">JABAWS versions compatibility and Jalview support </a></li>\r
  65   <li><a href="#cmdclient">Programmatic access to JABAWS</a></li>\r
  66 </ul>\r
  67 \r
  68 \r
  69 \r
  70 <h3><a name="wisjaba" id="wisjaba"></a>What is JABAWS?</h3>\r
  71 <p>\r
  72   JABAWS stands for JAva Bioinformatics Analysis Web Services. As the name suggests, JABAWS is a \r
  73   collection of web services for bioinformatics, and currently provides services that make it easy \r
  74   to access well-known multiple sequence alignment and protein disorder prediction programs \r
  75   (see <a href="#alprog">the list of currently supported programs</a>) from <a href="http://www.jalview.org">Jalview</a>.\r
  76   Future versions of JABAWS will incorporate many other tools.\r
  77 </p>\r
  78 <h4>Getting JABAWS</h4>\r
  79 <p>\r
  80   JABAWS consists of a server and client, but unlike most bioinformatics web service systems, you can download and \r
  81   run both parts on your own computer! If you want a server just for yourself, then download and install the JABAWS \r
  82   Virtual Appliance. It requires no configuration and is simple to install. If you want to install JABAWS for your \r
  83   lab or institution then download the JABAWS Web Application aRchive. It is slightly more complicated to configure \r
  84   but is very straightforward too. Finally, if you want to script against any version of JABAWS or are interested \r
  85   in writing your own client, the JABAWS command line client is what you need.\r
  86 </p>\r
  87 \r
  88 \r
  89 \r
  90 <h3><a name="wjaba" id="wjaba"></a>JABAWS Benefits</h3>\r
  91 <ul>\r
  92   <li>Can be deployed on most operating systems, as a VMware or other compatible Virtual Appliance or a Tomcat Java Web Application.</li>\r
  93   <li>Comes complete with sources and binaries for all the bioinformatics programs that it runs.</li>\r
  94   <li>Can operate as a stand alone server or one that submits jobs to a cluster <em>via</em> <a href="http://www.drmaa.org/">DRMAA</a>.</li>\r
  95   <li>Easy to access from <a href="http://www.jalview.org">Jalview</a> using its graphical client, or using the JABAWS command line client.</li>\r
  96   <li>Clients can submit jobs to any JABAWS servers that you might want to access, such as the one running on your local computer, \r
  97       your lab's server, or the publicly available services at the <a href="http://www.compbio.dundee.ac.uk/">University of Dundee</a>.</li>\r
  98   <li>Local or intranet installation eliminates any security concerns you might have about sending sensitive data over the internet.</li>\r
  99   <li>Wide range of configuration options to control size of jobs accepted by a server and the command line options available for the program run by a service.</li>\r
 100 </ul>\r
 101 \r
 102 \r
 103 \r
 104 <h3><a name="alprog" id="alprog"/>JABA Web Services Programs </h3>\r
 105 <p> JABAWS currently provides access to the following programs:</p>\r
 106 <p>Multiple Sequence Alignement </p>\r
 107 <ul>\r
 108   <li><a href="http://www.clustal.org/omega">Clustal Omega </a> (version 1.0.2)</li>\r
 109   <li><a href="http://www.clustal.org/clustal2">ClustalW</a> (version 2.52)</li>\r
 110   <li><a href="http://align.bmr.kyushu-u.ac.jp/mafft/software/">Mafft</a> (version 6.857)</li>\r
 111   <li><a href="http://www.drive5.com/muscle">Muscle</a> (version 3.8.31) </li>\r
 112   <li><a href="http://www.tcoffee.org/Projects_home_page/t_coffee_home_page.html">Tcoffee</a> (version 8.99) </li>\r
 113   <li><a href="http://probcons.stanford.edu/">Probcons</a> (version 1.12)</li>\r
 114 </ul>\r
 115 <p>Protein disorder prediction</p>\r
 116 <ul>\r
 117   <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://dis.embl.de/">DisEMBL</a></span> (1.5) </li>\r
 118   <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://iupred.enzim.hu">IUPred</a></span> (1.0) </li>\r
 119   <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://www.strubi.ox.ac.uk/RONN">Ronn</a></span> (3.1) </li>\r
 120   <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://globplot.embl.de/">GlobPlot</a></span> (2.3) </li>\r
 121   </ul>\r
 122 <p>Amino Acid conservation </p>\r
 123 <ul>\r
 124   <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://www.compbio.dundee.ac.uk/aacon">AACon</a></span> (1.0) </li>\r
 125 </ul>\r
 126 \r
 127 \r
 128 \r
 129 <h3><a name="jaba2.5"/></a>What is new in JABAWS 2.5? </h3>\r
 130 <strong>JABAWS Version 2.5 (Released 2nd Jul 2013)</strong><p>JABAWS 2.5 includes several bug fixes and minor updates for <a href="#jaba2">JABAWS Version 2</a>. These are listed below:</p>\r
 131 <ul>\r
 132   <li>Disembl returned swapped strings for HOTLOOPS and REM465</li>\r
 133   <li>Jronn failed to process jobs with more than 3 sequences</li>\r
 134   <li>JABAWS could not deal with FASTA records with '&gt' symbols in the record identificator</li>\r
 135   <li>Change of parameter description for AAcon: parameters have been replaced with options for calculation methods. This allows a user to get several AAcon's conservation scores \r
 136       in one call</li>\r
 137   <li>JABAWS never cleaned up job directories. Now JABAWS deletes the job directory if it exist longer then a period defined in Engine.properties</li>\r
 138   <li>Default web security has been incompatible with Tomcat 7.0.31 and newer</li>\r
 139   <li>Documentation has been updated</li>\r
 140   </ul>\r
 141   <a name="jaba2"/><strong>JABAWS Version 2 (Released 16th Dec 2011)</strong><p>Compared to JABAWS 1, JABAWS 2 offers a greater number and diversity of web services, Amazon EC2 integration and improved ease of use.</p><p>It contains:</p>\r
 142 <ul><li>updates for all multiple sequence alignment services</li>\r
 143   <li>four new protein disorder prediction services</li>\r
 144   <li>Clustal Omega multiple sequence alignment web service</li>\r
 145   <li>amino acid conservation service</li>\r
 146   <li>web services execution statistics visualization </li>\r
 147   <li>web services status check from a web page</li>\r
 148   <li>VirtualBox support was dropped in favour of VMware</li>\r
 149   <li>new WAR package for Mac users</li>\r
 150   <li>Amazon Machine Image (AMI) distributive to enable users to use JABAWS on the EC2 cloud</li>\r
 151   <li>Improved web services client API</li>\r
 152   <li>Simplified WAR package installation</li>\r
 153 </ul>\r
 154 \r
 155 \r
 156 \r
 157 <h3><a name="jabaclient" id="jabaclient"></a>What is JABAWS client?</h3>\r
 158 <p>\r
 159   A JABAWS client is a program that lets you run the bioinformatics methods for which a JABAWS server provides web \r
 160   services. The most basic JABAWS client is a command line Java application which can call any of the JABAWS web \r
 161   services methods on any instance of JABAWS Server that it can reach over the web. It is useful if you want to \r
 162   test, or execute the programs provided by a JABAWS server in your own scripts, and do not want to handle any web \r
 163   service specific details. The client is open source, so you can also use its source code to find out how to work \r
 164   with JABA Web Services if you would like to write your own client software. \r
 165   <a href="http://www.jalview.org/">Jalview</a>, which is a multiple sequence alignment and analysis application, \r
 166   provides a graphical JABAWS client. This client has the same functionality as the command line client, but \r
 167   instead allows JABAWS services to be accessed in a more user-friendly manner, through a graphical user interface.\r
 168 </p>\r
 169 \r
 170 \r
 171 \r
 172 <h3><a name="jalviewsup"></a>JABAWS versions compatibility and Jalview support </h3>\r
 173 <p>\r
 174   JABAWS version 2.5 is fully backward compatible with JABAWS v1.0 and v2.0. That means that all JABAWS v1.0 and \r
 175   v2.0 clients should also be able to use JABAWS 2.5 services. To access the analysis web services introduced in\r
 176   JABAWS 2.0, however, clients that were designed for JABAWS v1.0 must be updated.\r
 177 </p>\r
 178 \r
 179 \r
 180 \r
 181 <h3><a name="cmdclient" id="cmdclient"></a>Programmatic access to JABAWS </h3>\r
 182 <p>\r
 183   JABA Web Services are WS-I basic profile compliant, which means they can be accessed using any programming language \r
 184   or system that can utilize standard SOAP web services. The WSDL for each service is published on the JABAWS home \r
 185   page, and you can use this to automatically generate service bindings for your program. If you use Java, however, \r
 186   then you may wish to use our <a href="http://www.compbio.dundee.ac.uk/download">client package</a> to access JABAWS. \r
 187   This package is based on the autogenerated source code produced by <span class="hightlight">wsimport</span>, which \r
 188   is the Java tool for creating web service bindings; but in addition, offers some additional methods which simplify \r
 189   working with JABAWS. For more information please refer to the <a href="dm_javadoc/index.html">data model javadoc</a>.\r
 190 </p>\r
 191 </div><!-- content end-->\r
 192 <div id="copyright">Last update: 28 June 2013<br/>Sasha Sherstnev, Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of Dundee, UK</div>\r
 193 </div><!-- wrapper end-->\r
 194 </div><!-- page end-->\r
 195 \r
 196 \r
 197 <!-- Google analitics -->\r
 198 <script type="text/javascript">\r
 199 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");\r
 200 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));\r
 201 </script>\r
 202 <script type="text/javascript">\r
 203 try{\r
 204 var pageTracker = _gat._getTracker("UA-5356328-1");\r
 205 pageTracker._trackPageview();\r
 206 } catch(err) {}\r
 207 </script>\r
 208 </body>\r
 209 </html>\r