JAL-2371 ensure some colour scheme (may be None) is set on startup
[jalview.git] / help / html / vamsas / index.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ 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>VAMSAS Interoperation</title>
24 </head>
25 <body>
26   <p>
27     <strong>VAMSAS Interoperation</strong>
28   </p>
29   <p>
30     Jalview can interact with other applications using &quot;the <strong>VAMSAS
31       Interoperation framework</strong>&quot; which is an experimental model for
32     interoperation between bioinformatics applications (<strong>V</strong>isualization
33     and <strong>A</strong>nalysis of <strong>Molecular</strong> <strong>S</strong>equences,
34     <strong>Alignements</strong> and <strong>S</strong>tructures).
35     Currently, the only other VAMSAS enabled application is <a
36       href="http://www.topali.org">TOPALi</a> - a user friendly
37     program for phylogenetics and evolutionary analysis.
38   <p>
39     VAMSAS enabled applications access a shared bioinformatics dataset
40     containing sequences, alignments, annotation and trees, which can be
41     represented by an XML document analogous to a <a
42       href="../features/jalarchive.html">Jalview Project
43       Archive</a>.
44   </p>
45   <br>
46   <strong>Connecting to a VAMSAS session</strong>
47   <br> The VAMSAS functionality in Jalview is accessed through the
48   Desktop's
49   <strong>Vamsas</strong> menu. The options available in this menu
50   depend on whether the application is currently interacting with a
51   VAMSAS dataset in a
52   <strong>VAMSAS session</strong>. When the application is not connected
53   to a session is active, the menu options are as follows:
54   <br>
55   <ul>
56     <li><em>Connect to an existing session</em><br> If
57       visible, this submenu contains a list of existing sessions that
58       the VAMSAS framework has discovered on your computer. <br>
59       Choose one to connect to it.</li>
60     <li><em>New VAMSAS Session</em><br> This option will
61       create a new session on your computer.</li>
62     <li><em>Load VAMSAS Session...</em><br> This option will
63       open a file browser window allowing you to select a VAMSAS session
64       archive from which a new session will be created.<br /> <em>New
65         in 2.5:</em>Sessions created from an imported document inherit the
66       file or URL for the document.</li>
67
68   </ul>
69   <br>
70   <strong>VAMSAS and Firewalls</strong>: VAMSAS uses sockets to
71   communicate between different programs. This means that after starting
72   a session, your firewall software may ask you whether to allow the
73   java executable access to the internet (port 53782). If you do not
74   allow this, messages will not be exchanged with other VAMSAS
75   applications.
76   </br>
77   <br> Once you have successfully connected to a VAMSAS session,
78   any data made available by other VAMSAS applications will be
79   automatically imported into Jalview. However, in order to share the
80   data in Jalview with other VAMSAS applications, you must manually
81   select the
82   <strong>Vamsas&#8594;&quot;Session Update&quot;</strong> entry that is
83   visible when a session is active. Selecting this option will update
84   the VAMSAS session document, with the data loaded into Jalview. Any
85   new alignments, trees and annotation will be written to the session,
86   in addition to any edits you have made to data originally stored in
87   the document.
88   <br>
89   <strong>Saving the current session</strong>
90   <br> You can save the current session as a VAMSAS Session archive
91   using the
92   <strong>Vamsas&#8594;&quot;Session Update&quot;</strong>. The file
93   contains a snapshot of the current VAMSAS session, including data from
94   any other applications connected to the session.
95   <strong>Leaving a VAMSAS session</strong>
96   <br> A session can be disconnected from at any time using the
97   <strong>Vamsas&#8594;&quot;Stop Session&quot;</strong> option.
98   Selecting this option will only disconnect Jalview from the session -
99   any other applications will remain connected to the session. If
100   Jalview is the only application connected to the session and you have
101   not yet saved the VAMSAS session then you will be prompted with an
102   optional 'Save VAMSAS session...' dialog box, allowing the session to
103   be saved and returned to at a later date.
104   <br>
105   <strong>VAMSAS Session Persistence</strong>
106   <br> VAMSAS sessions are persistent - this means that they exist
107   independently of any VAMSAS applications that are connected to them.
108   This means that if something goes wrong with a VAMSAS application and
109   it crashes or otherwise fails, the VAMSAS session it is connected to
110   will (hopefully) be unaffected. For instance, if Jalview is killed or
111   crashes whilst it is still connected to a session, that session can be
112   recovered in a new Jalview instance using the
113   <strong>Vamsas&#8594;&quot;Existing session&quot;</strong> sub menu.
114   </p>
115   <p>
116     <strong>A quick Demo</strong> <br> Jalview can talk to itself
117     through VAMSAS. Simply start two copies of the application, create a
118     new vamsas session in one, and connect to the new session in the
119     other. Then load your data into one of the applications, and use the
120     <strong>Vamsas&#8594;&quot;Session Update&quot;</strong> menu entry
121     to try to propagate the data to the other application. <br>
122   <table>
123     <tr>
124       <td>Data Sharing Capability</td>
125       <td>Jalview Version</td>
126     </tr>
127     <tr>
128       <td>Alignments, sequences and annotation, trees, database
129         references, cDNA/protein mappings.</td>
130       <td>2.4</td>
131     </tr>
132     <tr>
133       <td>Mouseover location across linked DNA, protein and
134         structure positions.</td>
135       <td>2.4</td>
136     </tr>
137     <tr>
138       <td>Jalview project settings (Multiple views, groups, tree
139         partitions, colouring, window positions)</td>
140       <td>2.5</td>
141     </tr>
142     <tr>
143       <td>Sequence region and column selections</td>
144       <td>2.5</td>
145     </tr>
146   </table>
147   <br />
148   <p>
149     Version 0.2 of the VAMSAS client library is used in <em>Jalview
150       2.5</em>. For further details about the VAMSAS framework, please check
151     the <a href="http://www.vamsas.ac.uk">VAMSAS website</a>. The VAMSAS
152     framework is implemented as a Java 1.4 Library and depends on a
153     number of other open source projects. Its source is released under
154     the LGPL license. &nbsp;
155   </p>
156 </body>
157 </html>