1 <%--<?xml version="1.0" encoding="ISO-8859-1" ?>--%>
2 <%--<%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%>--%>
4 <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
5 <%@ taglib uri="http://java.sun.com/jsp/jstl/functions" prefix="fn" %>
6 <%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>
7 <%@ taglib uri="http://displaytag.sf.net" prefix="dt" %>
10 <c:import url="template_header.jsp" >
11 <c:param name="title">Documentation</c:param>
14 <ol class="breadcrumb">
15 <li><a href="${pageContext.request.contextPath}/index.jsp">Home</a></li>
16 <li><a href="man_docs.jsp">Documentation</a></li>
17 <li class="active"><a href="man_server_dev.jsp">Develop JABAWS</a></li>
20 <div class="col-md-12">
21 <div class="panel panel-default">
22 <div class="panel panel-heading">
23 <h1 class="panel-title">What is JABAWS?</h1>
25 <div class="panel-body">
28 <li><a href="#wisjaba">What is JABAWS?</a></li>
29 <li><a href="#wjaba">JABAWS Benefits</a></li>
30 <li><a href="#alprog">JABA Web Services Programs</a></li>
31 <li><a href="#jaba2.2">What is new in JABAWS 2.2?</a> </li>
32 <li><a href="#jabaclient">What is JABAWS Client</a>?</li>
33 <li><a href="#jalviewsup">JABAWS versions compatibility and Jalview support </a></li>
34 <li><a href="#cmdclient">Programmatic access to JABAWS</a></li>
36 <!--<p class="justify">-->
43 <div class="row" id="wisjaba">
44 <div class="col-md-12">
45 <div class="panel panel-default">
46 <div class="panel panel-heading">
47 <h1 class="panel-title">What is JABAWS?</h1>
49 <div class="panel-body">
51 JABAWS stands for JAva Bioinformatics Analysis Web Services. As the name suggests, JABAWS is a
52 collection of web services for bioinformatics, and currently provides services that make it easy
53 to access well-known multiple sequence alignment and protein disorder prediction programs
54 (see <a href="#alprog">the list of currently supported programs</a>) from <a href="http://www.jalview.org">Jalview</a>.
55 Future versions of JABAWS will incorporate other tools.
57 <strong>Getting JABAWS</strong>
59 JABAWS consists of a server and a client, but unlike most bioinformatics web service systems, you can download and
60 run both parts on your own computer! If you want a server just for yourself, then download and install the JABAWS
61 Virtual Appliance. It requires no configuration and is simple to install. If you want to install JABAWS for your
62 lab or institution then download the JABAWS Web Application aRchive. It is slightly more complicated to configure
63 but is very straightforward too. Finally, if you want to script against any version of JABAWS or are interested
64 in writing your own client, the JABAWS command line client is what you need.
66 <p class="text-right">
67 <a href="#">Back to top <i class="fa fa-arrow-up" aria-hidden="true"></i></a>
73 <div class="row" id="wjaba">
74 <div class="col-md-12">
75 <div class="panel panel-default">
76 <div class="panel panel-heading">
77 <h1 class="panel-title">JABAWS Benefits</h1>
79 <div class="panel-body">
81 <li>Can be deployed on most operating systems, as a VMware or other compatible Virtual Appliance or a Tomcat Java Web Application.</li>
82 <li>Comes complete with sources and binaries for all the bioinformatics programs that it runs.</li>
83 <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>
84 <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>
85 <li>Clients can submit jobs to any JABAWS servers that they might want to access, such as the one running on your local computer,
86 your lab's server, or the publicly available services at the <a href="http://www.compbio.dundee.ac.uk/">University of Dundee</a>.</li>
87 <li>Local or intranet installation eliminates any security concerns you might have about sending sensitive data over the internet.</li>
88 <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>
90 <p class="text-right">
91 <a href="#">Back to top <i class="fa fa-arrow-up" aria-hidden="true"></i></a>
97 <div class="row" id="alprog">
98 <div class="col-md-12">
99 <div class="panel panel-default">
100 <div class="panel panel-heading">
101 <h1 class="panel-title">JABA Web Services Programs</h1>
103 <div class="panel-body">
104 <p>JABAWS currently provides access to the following programs:</p>
105 <strong>Multiple Sequence Alignment</strong>
107 <li><a href="http://www.clustal.org/omega">Clustal Omega </a> (version 1.0.2)</li>
108 <li><a href="http://www.clustal.org/clustal2">ClustalW</a> (version 2.52)</li>
109 <li><a href="http://align.bmr.kyushu-u.ac.jp/mafft/software/">Mafft</a> (version 6.857)</li>
110 <li><a href="http://www.drive5.com/muscle">Muscle</a> (version 3.8.31) </li>
111 <li><a href="http://www.tcoffee.org/Projects_home_page/t_coffee_home_page.html">Tcoffee</a> (version 8.99) </li>
112 <li><a href="http://probcons.stanford.edu/">Probcons</a> (version 1.12)</li>
113 <li><a href="http://msaprobs.sourceforge.net/">MSAProbs</a> (version 0.9.7)</li>
114 <li><a href="http://sourceforge.net/projects/glprobs/">GLProbs</a> (version 0.9.7)</li>
117 <strong>Protein disorder prediction</strong>
119 <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://dis.embl.de/">DisEMBL</a></span> (version 1.5) </li>
120 <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://iupred.enzim.hu">IUPred</a></span> (version 1.0) </li>
121 <li><span style="color:black; font-weight:normal; text-align:left;">Jronn - Java implementation of <a href="http://www.strubi.ox.ac.uk/RONN">Ronn</a></span> (version 3.1) </li>
122 <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://globplot.embl.de/">GlobPlot</a></span> (version 2.3) </li>
124 <strong>Amino Acid conservation</strong>
126 <li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://www.compbio.dundee.ac.uk/aacon">AACon</a></span> (version 1.0) </li>
128 <strong>Secondary structure for an RNA aligment</strong>
130 <li><span style="color:black; font-weight:normal; text-align:left;">RNAalifold from <a href="http://www.tbi.univie.ac.at/RNA">ViennaRNA</a></span> (version 2.0) </li>
133 <!--<p>Protein Secondary structure prediction</p>-->
135 <!--<li><span style="color:black; font-weight:normal; text-align:left;"><a href="http://www.compbio.dundee.ac.uk/jpred/">Jpred</a></span> (version 4.0) is now provided by-->
136 <!--the <a href="http://www.compbio.dundee.ac.uk/jpred/api.shtml">Jpred REST API</a>.</li>-->
139 <!--<p class="justify">-->
140 <!--All these codes including Jronn and AAcon are available at the <a href="http://gjb-www-1.cluster.lifesci.dundee.ac.uk:8086/download">Download</a>-->
141 <!--section (registration is required).-->
143 <p class="text-right">
144 <a href="#">Back to top <i class="fa fa-arrow-up" aria-hidden="true"></i></a>
150 <div class="row" id="jaba2.2">
151 <div class="col-md-12">
152 <div class="panel panel-default">
153 <div class="panel panel-heading">
154 <h1 class="panel-title">What is new in JABAWS 2.2?</h1>
156 <div class="panel-body">
158 <strong>JABAWS Version 2.2 (Released XX Feb 2017)</strong>
159 <p >The website was improved and several service programs were update:</p>
161 <li>The versions of several application programs provided by JABAWS were bumped to the latest available.
162 Updated programs include: <mark> X, Y, Z</mark></li>
164 Protein secondary structure prediction with <a href="http://www.compbio.dundee.ac.uk/jpred/">Jpred</a> (version 3.0.3)
165 was dropped from the list of provided services, as the use of the dedicated
166 <a href="http://www.compbio.dundee.ac.uk/jpred/api.shtml">Jpred REST API</a> (Jpred 4) is encouraged and recommended.
167 This is the version that is currently provided within <a href="http://www.jalview.org/">Jalview</a> 2.9 or later.
170 The pre-configured JABAWS Amazon Machine Image (AMI),
171 which allowed for JABAWS to be run
172 in the <a href="http://aws.amazon.com/what-is-aws">Amazon EC2 cloud</a>, is no longer provided
173 due to very limited use by the scientific community.
177 <strong>JABAWS Version 2.1 (Released 1st Oct 2013)</strong>
178 <p>Several new web services are available in this version of JABAWS:</p>
180 <li>Two multiple sequence aligners (MSAprobs and GLprobs), both services return the standard Alignment object</li>
181 <li>RNAalifoldWS returns RNAStructScoreManager, which is the standard ScoreManager objects with several additional methods</li>
183 JpredWS returns the JpredAligment object, which is the standard alignment with additional methods for extracting
184 Jpred predictions. These predictions are supplied as additional sequences in the aligment
188 <p>Some bugs have been fixed and several improvements have been done:</p>
190 <li>WS status servlet returns version and some additional information on each web service</li>
191 <li>a bug with path to help in the client</li>
192 <li>Fix two bug with the Google Analytics library: no-stop due to running thread</li>
193 <li>GoogleAnalytics gets proper JABAWS version</li>
197 <strong>JABAWS Version 2.0.1 (Released 2nd Jul 2013)</strong><p>JABAWS 2.0.1 includes several bug fixes and minor updates for <a href="#jaba2">JABAWS Version 2.0</a>. These are listed below:</p>
199 <li>Disembl returned swapped strings for HOTLOOPS and REM465</li>
200 <li>Jronn failed to process jobs with more than 3 sequences</li>
201 <li>JABAWS could not deal with FASTA records with '>' symbols in the record identificator</li>
202 <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
204 <li>JABAWS never cleaned up job directories. Now JABAWS deletes the job directory if it exist longer than a period defined in Engine.properties</li>
205 <li>Default web security has been incompatible with Tomcat 7.0.31 and newer</li>
206 <li>Documentation has been updated</li>
209 <div id="jaba2"></div><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>
210 <ul><li>updates for all multiple sequence alignment services</li>
211 <li>four new protein disorder prediction services</li>
212 <li>Clustal Omega multiple sequence alignment web service</li>
213 <li>amino acid conservation service</li>
214 <li>web services execution statistics visualization </li>
215 <li>web services status check from a web page</li>
216 <li>VirtualBox support was dropped in favour of VMware</li>
217 <li>new WAR package for Mac users</li>
218 <li>Amazon Machine Image (AMI) distributive to enable users to use JABAWS on the EC2 cloud</li>
219 <li>Improved web services client API</li>
220 <li>Simplified WAR package installation</li>
223 <p class="text-right">
224 <a href="#">Back to top <i class="fa fa-arrow-up" aria-hidden="true"></i></a>
230 <div class="row" id="jabaclient">
231 <div class="col-md-12">
232 <div class="panel panel-default">
233 <div class="panel panel-heading">
234 <h1 class="panel-title">What is the JABAWS Client?</h1>
236 <div class="panel-body">
237 <p class="justify">A JABAWS client is a Java application that lets you run the programs for which a JABAWS server provides web
238 services. The most basic JABAWS client is a command line application this is able to call any of the JABAWS web
239 services on any instance of JABAWS Server available over the web. The basic client is useful if you would like
240 to test or execute the programs provided by theJABAWS server in your own scripts, but you do not want to handle
241 any web service specific details. The client is an open source software, so you can also use the source code to
242 as an example how to manipulate with JABAWS web services in your own code.
243 <a href="http://www.jalview.org/">Jalview</a>, a multiple sequence alignment and analysis application, is a good
244 example of a graphical JABAWS client. This client uses the same functionality as the command line client, but
245 instead allows JABAWS services to be accessed in a more user-friendly manner, through a graphical user interface.
247 <p class="text-right">
248 <a href="#">Back to top <i class="fa fa-arrow-up" aria-hidden="true"></i></a>
254 <div class="row" id="jalviewsup">
255 <div class="col-md-12">
256 <div class="panel panel-default">
257 <div class="panel panel-heading">
258 <h1 class="panel-title">JABAWS versions compatibility and Jalview support</h1>
260 <div class="panel-body">
262 JABAWS version 2.2 is fully backward compatible with JABAWS v1.0 and v2.0. This means all JABAWS 1.0, 2.0, 2.0.1 and
263 2.1 clients should also be able to use JABAWS 2.2 services. To access the analysis web services introduced in
264 JABAWS 2.0, however, clients that were designed for JABAWS v1.0 must be updated.
266 <p class="text-right">
267 <a href="#">Back to top <i class="fa fa-arrow-up" aria-hidden="true"></i></a>
273 <div class="row" id="cmdclient">
274 <div class="col-md-12">
275 <div class="panel panel-default">
276 <div class="panel panel-heading">
277 <h1 class="panel-title">Programmatic access to JABAWS</h1>
279 <div class="panel-body">
281 JABAWS web services are WS-I basic profile compliant, which means they can be accessed
282 using any programming language
283 or system that can utilize standard SOAP web services. The WSDL for each service is
284 published on the JABAWS home
285 page, and you can use this to automatically generate service bindings for your program.
287 you may wish to use our
288 <a href="http://gjb-www-1.cluster.lifesci.dundee.ac.uk:8086/jabaws-dev">client package</a> to access JABAWS.
289 This package is based on the autogenerated source code produced by
290 <em2>wsimport</em2>, which
291 is the Java tool for creating web service bindings. In addition, this offers some
292 additional methods that simplify
293 working with JABAWS. For more information please refer to the
294 <a href="dm_javadoc/index.html">data model javadoc</a>.
301 <jsp:include page="template_footer.jsp" />