help/html/vamsas/index.html

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