help/html/features/chimera.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>The Chimera PDB Viewer</title>
  24 </head>
  25 <body>
  26 <p><strong>The Chimera Viewer</strong></p>
  27 <p>Since Jalview 2.8.2, <a href="http://www.cgl.ucsf.edu/chimera/">Chimera</a> (http://www.cgl.ucsf.edu/chimera/)
  28 has been integrated into Jalview for interactively viewing structures
  29 opened by entries in the <strong>&quot;Structure&quot;</strong> submenu in the <a href="../menus/popupMenu.html">sequence
  30 id pop-up menu</a> (if you can't see this, then you need to <a
  31         href="viewingpdbs.html">associate a PDB structure</a> with the
  32 sequence). Chimera is available from the Jalview desktop, provided Chimera has been separately installed.</p>
  33 <p>You can set a default choice of Jmol or Chimera structure viewer in <a href="preferences.html#structure"> Preferences</a>.
  34 You can also optionally specify the path to the Chimera program here (if it differs from the standard paths searched by Jalview).
  35 <p>If you save your Jalview session as a project file, the state of any open Chimera windows will also be saved, and can be reopened by loading the project file on any machine with Chimera installed. <em>Since Jalview 2.9.</em>
  36 <!-- <p>The following menu entries are provided for viewing structure data<br>
  37   <ul>
  38     <li>The <strong>&quot;Structure&#8594;View
  39         Structure&#8594;</strong> submenu allows a single PDB structure to be chosen
  40       for display from the available structures for a sequence.
  41     </li>
  42     <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
  43         structures
  44     </strong> option will open a new window containing all structures associated
  45       with the current selection.
  46     </li>
  47     <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
  48         representative structures
  49     </strong> option will open a new window containing exactly one structure per
  50       currently selected sequence.<br /></li>
  51   </ul>
  52   <br>
  53 </p> -->
  54 <p><a name="align"><strong>Superposing structures based
  55 on their aligned sequences</strong></a><br>
  56 If several structures are available on the alignment, you may add
  57 additional structures to an existing Chimera view by selecting their entry
  58 in the appropriate pop-up menu. Jalview will ask you if you wish to add
  59 the structure to the existing alignment, and if you do, it will import
  60 and superimpose the new PDB file using the corresponding positions from
  61 the alignment. If the alignment is subsequently edited, you can use the
  62 <a href="#sAlign"><em>Chimera&#8594;Align</em></a> menu option from the
  63 menu bar of the structure view window to superpose the structures using
  64 the updated alignment.<br>
  65 </p>
  66 <p><strong>Chimera Controls</strong><br>
  67 The structure is by default rendered as a ribbon diagram. Moving the
  68 mouse over the structure brings up tooltips giving the residue name, PDB
  69 residue number and chain code
  70 ([RES]Num:Chain). Moving the mouse over an
  71 associated residue in an alignment window highlights the associated
  72 atoms in the displayed structures. When residues are selected in the Chimera window, they are highlighted on the alignment. For comprehensive details of Chimera's commands, refer to the tool's Help menu.
  73 <p>Basic screen operations (see <a href="http://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/mouse.html">Chimera help</a>
  74 at http://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/mouse.html for full details).
  75 <table border="1">
  76         <tr>
  77                 <td><strong>Action</strong></td>
  78                 <td><strong>Windows</strong></td>
  79                 <td><strong>Unix</strong></td>
  80                 <td><strong>Mac/OSX</strong></td>
  81         </tr>
  82         <tr>
  83                 <td>Rotate View</td>
  84                 <td>Left Click and Drag</td>
  85                 <td>Left Click and Drag</td>
  86                 <td>Left Click and Drag</td>
  87         </tr>
  88         <tr>
  89                 <td>Zoom</td><td>Right Click<br>
  90                 drag mouse up or down</td>
  91                 <td>Right Click<br>drag mouse up or down</td>
  92                 <td>cmd or Right + Click and drag mouse up or down, <br>or use mouse scroll button</td>
  93         </tr>
  94         <tr>
  95                 <td>Move Origin</td>
  96                 <td>Middle Button + Drag</td>
  97                 <td>Middle Button and drag</td>
  98                 <td>alt + Click<br>
  99                 and drag</td>
 100         </tr>
 101         <tr>
 102                 <td>Select Residues</td>
 103                 <td>Ctrl + Click (and drag to select a region)</td>
 104                 <td>Ctrl + Click (and drag)</td>
 105                 <td>Ctrl + Click (and drag)</td>
 106         </tr>
 107 </table>
 108 </p>
 109 <p><strong>Jalview Controls</strong>
 110 <p>The Jalview Chimera View window has up to five menus:</p>
 111 <ul>
 112         <li><Strong>File<br>
 113         </strong>
 114         <ul>
 115                 <li><strong>View Mapping<br>
 116                 </strong><em> Opens a text window showing the alignment between the
 117                 residues corresponding to alpha-carbon atoms in the PDB structure and
 118                 the residues in the associated sequence.</em></li>
 119         </ul>
 120         </li>
 121         <li><strong>View</strong>
 122         <ul>
 123                 <li><strong>Show Chains<br>
 124                 </strong><em>Select which of the PDB file's chains (if more than one) are to be displayed.</em></li>
 125                 <li><strong>Colour by ..<br></strong><em>Submenu allowing specific alignment views to be selected for colouring associated chains in the structure display. This menu contains all the alignment views associated with the structure view, with those used to colour the view indicated by ticks. Addditionally, it contains the following menu entries:</em>
 126                 <ul><li><strong>Select many views<br></strong><em>When this option is enabled, selecting an alignment view adds it to the set used to colour the structures. Use this when colouring structures related to a number of alignments involving different domains or chains which are shown in the same structure view.</em>
 127                 </li>
 128     <li><strong>Select all views<br></strong><em>This is only enabled when </em><strong>Select many views</strong><em> is also enabled, and will add all associated views to the set used to colour the structure display.</em>
 129   </li>
 130     <li><strong>Invert selection<br></strong><em>This is only enabled when </em><strong>Select many views</strong><em> is also enabled, and will replace the current set of views with any remaining views not currently used to colour the structure display.</em>
 131   </li></ul></li></ul>
 132         <li><strong>Colours<br>
 133         </strong>
 134         <ul>
 135                 <li><strong>By Sequence<br>
 136                 </strong><em> Colours each residue in the structure with the colour of its
 137                 corresponding residue in the associated sequence as rendered in the
 138                 associated alignment views, including any Uniprot sequence features or
 139                 region colourings.<br/>Pick which of the associated alignment views are used to colour the structures using the <strong>View&#8594;Colour by ..</strong> sub menu.</em><br>
 140                 Residues which only exist in the PDB structure are coloured white if
 141                 they are insertions (relative to the associated sequence in the
 142                 alignment) and grey if they are N or C terminal flanks outside the
 143                 region mapped to the alignment window's sequence.</em></li>
 144                 <li><strong>By Chain<br>
 145                 </strong><em>Uses the Chimera 'rainbow chain' command to apply a different colour to each chain.</em></li>
 146                 <li><strong>Charge &amp; Cysteine<br>
 147                 </strong><em> Highlights cysteines in yellow, anionic (Aspartic Acid or
 148                 Glutamic Acid) residues in red, and cationic (Lysine or Arginine)
 149                 residues in blue.</em></li>
 150                 <li><strong>Colour with Chimera<br></strong><em>Defers any colouring operations to Chimera. Select this if you want to use the
 151                 Chimera scripting interface or menu to modify the view directly.</em></li>
 152                 <li><strong>Standard and User Defined Jalview
 153                 colourschemes.<br>
 154                 </strong><em>The remaining entries apply the colourschemes available from
 155                 the standard and user defined <a href="../colourSchemes/index.html">amino
 156                 acid colours</a>.</em></li>
 157         </ul>
 158         </li>
 159         <li><strong>Chimera<br>
 160         </strong><em>This pulldown menu is only displayed if there are multiple
 161         structures shown in the Chimera window, and Jalview can also locate at
 162         least two of the structures in the currently associated alignment view.</em>
 163         <ul>
 164                 <li><strong><a name="sAlign">Align</a> <br>
 165                 </strong><em> When selected, the associated alignment will be used to
 166                 superimpose all the structures in the view onto the first structure in
 167                 the alignment. The regions used to calculate the superposition will be
 168                 highlighted using the 'Cartoon' rendering style, and the remaining
 169                 data shown as a chain trace.<br></em></li>
 170         </ul>
 171         </li>
 172         <li><strong>Help<br>
 173         </strong>
 174         <ul>
 175                 <li><strong>Chimera Help<br>
 176                 </strong><em>Access the Chimera Help documentation in a new browser window.</em></li>
 177         </ul>
 178         </li>
 179 </ul>
 180 <p><strong>Chimera and Windows Firewall</strong></p>
 181 Jalview and Chimera communicate using Chimera's <a href="http://www.cgl.ucsf.edu/chimera/current/docs/ContributedSoftware/restserver/restserver.html">REST service</a> (http://www.cgl.ucsf.edu/chimera/current/docs/ContributedSoftware/restserver/restserver.html).<br>
 182 Technically this requires both Chimera and Jalview to open ports on the local network, and this may be blocked by Windows Firewall with a warning message such as<br/>
 183 "Windows Firewall has blocked some features of this program" (where the program may be jp2launcher.exe for Jalview Webstart, or java.exe or javaw.exe for the InstallAnywhere version).<br/>
 184 To allow Jalview and Chimera to interact, you may need to add permission for the program to communicate over the network. This can be done from the warning dialogue, or in Control Panel, Firewall settings.
 185 </body>
 186 </html>