help/html/vamsas/index.html

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