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