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