9bfd4ebd33f6104a7b24a383c2b5f7c61c3ea635
[jabaws.git] / website / man_about.html
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE html PUBLIC "XHTML 1.0 Strict" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml">\r
4 <head>\r
5 <meta name="Last-modified" content="Mon, 4 Apr 2011 12:00:00 GMT"/>\r
6 <title>Java Bioinformatics Analyses Web Services (JABAWS) manual - About</title>\r
7 <link href="ws.css" rel="stylesheet" type="text/css" media="screen,  projection, handheld, tv" />\r
8 <link rel="stylesheet" type="text/css" media="print" href="print.css"/>\r
9 \r
10 <script type="text/javascript" src="prototype-1.6.0.3.js"></script>\r
11 </head>\r
12 <body>\r
13 <div id="page">\r
14 <div id="banner">\r
15 <table> \r
16 <tr><td style="width:158px;"><a href="http://www.dundee.ac.uk"><img src="images/uod_lt_long.gif"  alt="University of Dundee" width="158" height="90" class="logo"  title="University of Dundee" longdesc="http://www.dundee.ac.uk"/></a></td>\r
17 <td class="bg"><img src="images/jabaws2.png" alt="JABAWS-2.0" title="Java Bioinformatics Analysis Web Services version 2.0"/></td>\r
18 <td class="bg"><img src="images/banner_right.png" alt="Disorder" width="200" height="80"/></td>\r
19 </tr>\r
20 </table>\r
21 </div><!-- banner end-->\r
22 <div id="wrapper">\r
23 <div id="panel">\r
24         <a href="index.html">Home</a>\r
25     <a href="quick_start.html">Getting Started</a> \r
26          <a class="selected" href="man_about.html">Manual</a> \r
27         <div id="submenu">\r
28                 <a class="selected" href="man_about.html">About</a>\r
29                 <a href="man_servervm.html" title="JABAWS Server as Virtual Appliance">Server VA</a>\r
30                 <a href="man_awscloud.html" title="JABAWS Server in the Amazon EC2 Cloud">Server in the Cloud</a>\r
31                 <a href="man_serverwar.html" title="JABAWS Server as Web Application aRchive">Server WAR</a>\r
32                 <a href="man_configuration.html" >Server<br/>\r
33                 Configuration</a>\r
34                 <a href="man_client.html" title="JABAWS Command Line Client">CMD Client</a>\r
35                 <a href="man_stats.html" title="JABAWS Usage Statistics">Usage Statistics</a>\r
36                 <a href="man_dev.html" title="Accessing JABAWS from your program">Accessing<br/>\r
37                 JABAWS</a>      \r
38                 <a href="man_server_dev.html" >JABAWS Development</a>\r
39         </div>\r
40         <a href="http://www.compbio.dundee.ac.uk/downloads/jabaws">Download</a>\r
41         <a href="PublicAnnualStat" title="JABAWS usage statistics">Usage Statistics</a>\r
42      <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
43         <a href="contacts.html">Contact Us</a>\r
44     <a href="http://www.compbio.dundee.ac.uk" title="University of Dundee, The Barton Group" >Barton Group</a></div>\r
45 \r
46 <!-- panel end-->\r
47 <div id="content">\r
48 \r
49 <h2 id="headtitle">JABAWS MANUAL</h2>\r
50 <h2>About</h2>\r
51 \r
52 <ul>\r
53   <li><a href="#wisjaba">What is JABAWS?</a></li>\r
54   <li><a href="#wjaba">JABAWS Benefits</a></li>\r
55   <li><a href="#alprog">JABA Web Services Programs </a></li>\r
56   <li><a href="#jabaclient">What is JABAWS Client</a>?</li>\r
57   <li><a href="#cmdclient">Programmatic access to JABAWS</a></li>\r
58   </ul>\r
59 \r
60 \r
61 <h3><a name="wisjaba" id="wisjaba"></a>What is JABAWS?</h3>\r
62 <p>JABAWS stands for JAva Bioinformatics Analysis Web Services. As the name suggests, JABAWS is a collection of web services for bioinformatics, and currently provides services that make it easy to access well-known multiple sequence alignment and protein disorder prediction programs (see <a href="#alprog">the list of currently supported programs</a>) from <a href="http://www.jalview.org">Jalview</a>.\r
63   Future versions of JABAWS will incorporate many other tools.</p>\r
64 <h4>Getting JABAWS</h4>\r
65 <p>JABAWS consists of a server and client, but unlike most bioinformatics web service systems, you can download and run both parts on your own computer! If you want a server just for yourself, then download and install the JABAWS Virtual Appliance. It requires no configuration and is simple to install. If you want to install JABAWS for your lab or institution then download the 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 are interested in writing your own client, the JABAWS command line client is what you need. </p>\r
66 <h3><a name="wjaba" id="wjaba"></a>JABAWS Benefits</h3>\r
67 <ul>\r
68 <li>Can be deployed on most operating systems, as a VMware or other compatible Virtual Appliance or a Tomcat Java Web Application.</li>\r
69 <li>Comes complete with sources and binaries for all the bioinformatics programs that it runs.</li>\r
70 <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
71 <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
72 <li>Clients can submit jobs to any JABAWS servers that you might want to access, such as the one running on your local computer, 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
73 <li>Local or intranet installation eliminates any security concerns you might have about sending sensitive data over the internet.</li>\r
74 <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
75 </ul>\r
76 <h3><a name="alprog" id="alprog"/>JABA Web Services Programs </h3>\r
77 <p> JABAWS currently provides access to the following programs:</p>\r
78 <p>Multiple Sequence Alignement </p>\r
79 <ul>\r
80   <li><a href="http://www.clustal.org/omega">Clustal Omega </a> (version 1.0.2)</li>\r
81   <li><a href="http://www.clustal.org/clustal2">ClustalW</a> (version 2.0.12)</li>\r
82   <li><a href="http://align.bmr.kyushu-u.ac.jp/mafft/software/">Mafft</a> (version 6.857)</li>\r
83   <li><a href="http://www.drive5.com/muscle">Muscle</a> (version 3.8.31) </li>\r
84   <li><a href="http://www.tcoffee.org/Projects_home_page/t_coffee_home_page.html">Tcoffee</a> (version 8.99) </li>\r
85   <li><a href="http://probcons.stanford.edu/">Probcons</a> (version 1.12)</li>\r
86   </ul>\r
87 \r
88 <p>Protein disorder prediction</p>\r
89 <ul>\r
90   <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://dis.embl.de/">DisEMBL</a></span> (1.5) </li>\r
91   <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://iupred.enzim.hu">IUPred</a></span> (1.0) </li>\r
92   <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
93   <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://globplot.embl.de/">GlobPlot</a></span> (2.3) </li>\r
94   </ul>\r
95 <p>Amino Acid conservation </p>\r
96 <ul>\r
97   <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
98 </ul>\r
99 <h3><a name="jabaclient" id="jabaclient"></a>What is JABAWS client?</h3>\r
100 <p>A JABAWS client is a program that lets you run the bioinformatics methods for which a JABAWS server provides web services. \r
101 The most basic JABAWS client is a command line Java application which can call any of the JABAWS web services methods \r
102 on any instance of JABAWS Server that it can reach over the web. It is useful if you \r
103 want to test, or execute the programs provided by a JABAWS server in your own scripts, and do not want to handle any web service \r
104 specific details. The client is open source, so you can also use its source code to find \r
105 out how to work with JABA Web Services if you would like to write your own client \r
106 software. <a href="http://www.jalview.org/">Jalview</a>, which is a multiple sequence alignment and analysis application, provides a graphical JABAWS client. This client has the same \r
107 functionality as the command line client, but instead allows JABAWS services to be accessed in a more user-friendly manner, through a graphical user interface.</p>\r
108 <h3><a name="cmdclient" id="cmdclient"></a>Programmatic access to JABAWS </h3>\r
109 <p>JABA Web Services are WS-I basic profile compliant, which means they can be accessed using \r
110 any programming language or system that can utilize standard SOAP web services. \r
111 The WSDL for each service is published on the JABAWS home page, and you can use this to automatically generate \r
112 service bindings for your program. If you use Java, however, then you may wish to use our \r
113 <a href="http://www.compbio.dundee.ac.uk/downloads/jabaws">client package</a> to access JABAWS. \r
114 This package is based on the autogenerated source code produced by <span class="hightlight">wsimport</span>, which is the Java tool for creating web service bindings; \r
115 but in addition, offers some additional methods which simplify working with JABAWS. For more information please refer to the \r
116 <a href="dm_javadoc/index.html">data model javadoc</a>.\r
117 </p>\r
118 </div> \r
119 <!-- about end-->\r
120 <!-- content end--> \r
121 <div id="copyright">Last update: 16 September 2011<br/>\r
122 Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of Dundee, UK</div>\r
123 \r
124 </div>\r
125 </div><!-- wrapper end-->\r
126 \r
127 <!-- Google analitics -->\r
128 <script type="text/javascript">\r
129 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");\r
130 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));\r
131 </script>\r
132 <script type="text/javascript">\r
133 try{\r
134 var pageTracker = _gat._getTracker("UA-5356328-1");\r
135 pageTracker._trackPageview();\r
136 } catch(err) {}\r
137 </script>\r
138 \r
139 </body>\r
140 </html>\r
141 \r