help/html/vamsas/index.html

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