JAL-1620 version bump and release notes
[jalview.git] / help / html / webServices / JABAWS.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
4  * Copyright (C) 2014 The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *  
13  * Jalview is distributed in the hope that it will be useful, but 
14  * WITHOUT ANY WARRANTY; without even the implied warranty 
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
16  * PURPOSE.  See the GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
20  * The Jalview Authors are detailed in the 'AUTHORS' file.
21  -->
22 <head>
23 <title>The JABAWS system</title>
24 </head>
25 <body>
26 <p><strong>The</strong> <strong><em>JA</em></strong>va <strong><em>B</em></strong>ioinformatics
27 <strong><em>A</em></strong>nalysis <strong><em>W</em></strong>eb <strong><em>S</em></strong>ervices
28 <strong>system</strong> (<strong>JABAWS</strong>)<br>
29 Jalview includes a client for interacting with programmatic (SOAP) web
30 services for the <a href="http://www.compbio.dundee.ac.uk/jabaws">JABAWS</a>
31 service model, developed at the University of Dundee by Peter Troshin
32 and Geoff Barton. This is an open source system that provides a
33 framework for wrapping command line bioinformatics analysis programs
34 that enables them to be executed locally or on a cluster using data and
35 analysis parameters provided by a program linked with the JABA engine directly or
36 accessing it remotely <em>via</em> its web services interface.</p>
37 <p>The list of JABAWS servers known to the Jalview desktop is shown
38 in the <a href="webServicesPrefs.html">Web Services Preferences
39 Panel</a>, and detailed information about a particular service is available
40 from the help text and web pages accessible from its <a
41         href="webServicesParams.html">job parameters dialog box</a>.</p>
42 <p><strong>Obtaining JABAWS</strong><br>
43 One of the aims of JABAWS is to enable you to easily perform
44 computationally intensive bioinformatics analysis tasks using your own
45 computational facilities. It can be installed on a workstation to
46 provide stand-alone execution of analysis programs, or as a job
47 submission engine - enabling larger numbers of jobs to be handled. If
48 you would like to download and install JABAWS for your own use, please
49 go to <a href="http://www.compbio.dundee.ac.uk/jabaws">http://www.compbio.dundee.ac.uk/jabaws</a>
50 for more information.</p>
51 <p><strong>Configuring your own JABAWS services for use by
52 Jalview</strong><br>
53 Once you have downloaded and installed JABAWS, and verified it is
54 working, all that is needed is to add the URL for your JABAWS server(s) to
55 the list in the <a href="webServicesPrefs.html">Web Services
56 Preferences Panel</a>. After adding your service and saving your preferences
57 or hitting the 'refresh web services' button, you should be able to
58 submit jobs to the server via the alignment window's web services menu.
59 Your JABAWS servers list is stored in your Jalview preferences, so you
60 will only have to configure Jalview once for each new server.</p>
61 <p><em>Support for accessing JABAWS servers was introduced in
62 Jalview 2.6.</em></p>
63 <p><em>Option for adding JABAWS servers which fails validation 
64 was introduced from version 2.8.2 </em></p>
65 </body>
66 </html>