Replacing web site content with fresh version from JWS2 (JABAWS production ) branch
[jabaws.git] / website / man_about.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 - About</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 href="manual.html">Quick Start Guide</a>\r
27                 <a class="selected" 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>About</h2>\r
43 \r
44 <ul>\r
45   <li><a href="#wisjaba">What is JABAWS?</a></li>\r
46   <li><a href="#wjaba">JABAWS Benefits</a></li>\r
47   <li><a href="#alprog">JABA Web Services Programs </a></li>\r
48   <li><a href="#whatserver">What is JABAWS Server?</a></li>\r
49   <li><a href="#jabaclient">What is JABAWS Client</a>?</li>\r
50   <li><a href="#cmdclient">Programmatic access to JABAWS</a></li>\r
51   </ul>\r
52 \r
53 \r
54 <h3><a name="wisjaba" id="wisjaba"></a>What is JABAWS?</h3>\r
55 <p>JABAWS stands for JAva Bioinformatics Analysis Web Services. It is a collection of web services for multiple sequence alignment. For simplicity we referrer to them as JABAWS.  Right now, JABAWS makes it easy to access well-known multiple sequence alignment programs from JalView. However, the scope of JABAWS is not limited to multiple sequence alignment programs. Future versions of JABAWS  will incorporate protein disorder prediction, BLAST, PSIBLAST and HMMER database searches and many other tools. For the list of currently supported programs see <a href="#alprog">here.</a> JABAWS consists of the two parts - the server and the client. Unlike other web services you can download and use both on your own computer! If you want a server just for yourself, then download and install JABAWS Virtual Appliance. It requires no configuration and simple to install. If you want to install JABAWS for your own lab then download JABAWS Web Application aRchive. It is slightly more complicated to configure but is very straightforward too. Finally, if you want to script against any version of JABAWS or interested in writing your own client, the JABAWS command line client is what you need. </p>\r
56 <h3><a name="wjaba" id="wjaba"></a>JABAWS Benefits</h3>\r
57 <p>JABAWS can be deployed  on many operating system and operate as a stand alone server or submit the jobs to the cluster. Thanks to <a href="http://www.drmaa.org/">DRMAA</a> it integrates well with a large variety of cluster job management systems. <a href="http://www.jalview.org">Jalview</a> from version 2.6 integrates with JABAWS and can be configured to submit jobs to different versions of JABAWS, for example to your local, lab version, or publicly available version elsewhere.  As JABAWS can be installed in your lab, or indeed on your personal computer, it eliminates the need to send your private information to the outside, to one of the publicly accessible servers. JABAWS can run programs with additional parameters defined by you, so you are no longer limited to defaults. JABAWS is safe to install for public access as it could limit the size of the tasks which it accepts and denies access to resources within web application folder. </p>\r
58 <h3><a name="alprog" id="alprog"/>JABA Web Services Programs </h3>\r
59 <p> JABAWS currently uses the following programs under the hood </p>\r
60 <ul>\r
61   <li><a href="http://www.clustal.org/">ClustalW</a> (version 2.0.12)</li>\r
62   <li><a href="http://align.bmr.kyushu-u.ac.jp/mafft/software/">Mafft</a> (version 6.713)</li>\r
63   <li><a href="http://www.drive5.com/muscle">Muscle</a> (version 3.7) </li>\r
64   <li><a href="http://www.tcoffee.org/Projects_home_page/t_coffee_home_page.html">Tcoffee</a> (version 8.14) </li>\r
65   <li><a href="http://probcons.stanford.edu/">Probcons</a> (version 1.12)</li>\r
66   </ul>\r
67 \r
68 <h3><a name="whatserver" id="whatserver"></a>What is JABAWS Server? </h3>\r
69 <p>JABAWS Server is a Web Application which exposes a number of widely used Bioinformatics programs as SOAP web services. Currently it supports 5 multiple<a href="#alprog"> sequence alignment programs</a>. You can download and install JABAWS on your own computer. JABAWS can be configured to execute programs on computer it is installed or submit them to the cluster. JABAWS provides the uniform API for each web service if supports. </p>\r
70 <h3><a name="jabaclient" id="jabaclient"></a>What is JABAWS client?</h3>\r
71 <p>JABAWS client is a command line Java application which can call all JABAWS methods on any instance of JABAWS Server, no matter local or remote. It is useful if you want to script against a JABAWS server and do not want to handle any web service specific details. We also offer a source code of the client so that you can find out how to work with JABA Web Services if you would like to write your own client software. JABAWS command line client offers the same functionality as Jalview when connected to JABAWS. </p>\r
72 <h3><a name="cmdclient" id="cmdclient"></a>Programmatic access to JABAWS </h3>\r
73 <p>JABA Web Services are WS-I basic profile compliant, they can be accessed in a standard way as any other web service. The WSDL for each service is published on the JABAWS home page. If you use Java, then you can use our  <a href="download.html#minclient">client package</a> to access JABAWS.  This package contains value objects which you could alternatively generate with <span class="hightlight">wsimport</span> in Java, or similar tool in other language. On top of that it offers some additional methods which further simplify working with JABAWS. For more information please refer to the <a href="dm_javadoc/index.html">data model javadoc</a>. </p>\r
74 </div> \r
75 <!-- about end-->\r
76 </div>\r
77 <!-- content end--> \r
78 <div id="copyright">Last update: 7 January 2011<br/>\r
79 Peter Troshin and Geoff Barton, The Barton Group, University of Dundee, UK</div>\r
80 </div><!-- wrapper end-->\r
81 </div> <!-- page end-->\r
82 \r
83 <!-- Google analitics -->\r
84 <script type="text/javascript">\r
85 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");\r
86 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));\r
87 </script>\r
88 <script type="text/javascript">\r
89 try{\r
90 var pageTracker = _gat._getTracker("UA-5356328-1");\r
91 pageTracker._trackPageview();\r
92 } catch(err) {}\r
93 </script>\r
94 </body>\r
95 </html>\r
96 \r