help/html/features/jmol.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   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>The Jmol PDB Viewer</title>
  22 </head>
  23 <body>
  24 <p><strong>The Jmol PDB Viewer</strong></p>
  25 <p>Since Jalview 2.3, <a href="http://jmol.sourceforge.net/">Jmol</a>
  26 has been integrated into Jalview for interactively viewing structures
  27 opened by entries in the <strong>&quot;Structure&quot;</strong> submenu in the <a href="../menus/popupMenu.html">sequence
  28 id pop-up menu</a> (if you can't see this, then you need to <a
  29         href="viewingpdbs.html">associate a PDB structure</a> with the
  30 sequence). Jmol is available from the Jalview desktop and should also
  31 run in the JalviewLite applet, providing the browser supports Java 1.5.
  32 If Jmol is not available, then the original <a href="pdbviewer.html">internal
  33 pdb viewer</a> will be used as a fallback.</p>
  34 <p>The following menu entries are provided for viewing structure data<br>
  35   <ul>
  36     <li>The <strong>&quot;Structure&#8594;View
  37         Structure&#8594;</strong> submenu allows a single PDB structure to be chosen
  38       for display from the available structures for a sequence.
  39     </li>
  40     <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
  41         structures
  42     </strong> option will open a new window containing all structures associated
  43       with the current selection.
  44     </li>
  45     <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
  46         representative structures
  47     </strong> option will open a new window containing exactly one structure per
  48       currently selected sequence.<br />
  49     <em>The View representative structures option was introduced in
  50         Jalview 2.8.1</em></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 Jmol 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>Jmol&#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 <em>Sequence based structure superposition was added in Jalview 2.6</em>
  66 </p>
  67 <p><strong>Controls</strong><br>
  68 The structure is by default rendered as a ribbon diagram. Moving the
  69 mouse over the structure brings up tooltips giving the residue name, PDB
  70 residue number and chain code, atom name and number
  71 ([RES]Num:Chain.AtomName#AtomNumber). If a mapping exists to a residue
  72 in any associated sequences, then this will be highlighted in each one's
  73 alignment window. The converse also occurs - moving the mouse over an
  74 associated residue in an alignment window highlights the associated
  75 atoms in the displayed structures.</p>
  76 <p>Selecting a residue highlights its associated sequence residue
  77 and alpha carbon location. Double clicking an atom allows distances to
  78 be measured from it to any other atom in the structure.</p>
  79 <p>
  80 <table>
  81         <tr>
  82                 <td><strong>Action</strong></td>
  83                 <td><strong>Windows</strong></td>
  84                 <td><strong>Unix</strong></td>
  85                 <td><strong>Mac/OSX</strong></td>
  86         </tr>
  87         <tr>
  88                 <td>Rotate View</td>
  89                 <td>Left Click and Drag</td>
  90                 <td>Left Click and Drag</td>
  91                 <td>Click and Drag</td>
  92         </tr>
  93         <tr>
  94                 <td>Zoom</td>
  95                 <td>Shift + Left Click<br>
  96                 drag mouse up or down</td>
  97                 <td>Shift + Left Click<br>
  98                 or middle button<br>
  99                 drag mouse up or down</td>
 100                 <td>Left-Alt + Click and drag mouse up or down</td>
 101         </tr>
 102         <tr>
 103                 <td>Select/<br>
 104                 Deselect<br>
 105                 Residue</td>
 106                 <td>Left Click</td>
 107                 <td>Left Click</td>
 108                 <td>Click</td>
 109         </tr>
 110         <tr>
 111                 <td>Roll View</td>
 112                 <td>Shift + Left Click<br>
 113                 drag mouse to left or right</td>
 114                 <td>Shift + Left Click<br>
 115                 or middle button<br>
 116                 drag mouse to left or right</td>
 117                 <td>Left-Alt + Click and drag mouse to left or right</td>
 118         </tr>
 119         <tr>
 120                 <td>Move Origin</td>
 121                 <td>Shift+Control+Left Click<br>
 122                 or Middle Button<br>
 123                 + Drag</td>
 124                 <td>Middle-Button<br>
 125                 and<br>
 126                 drag</td>
 127                 <td>Shift+Control+Left Click<br>
 128                 or Middle Button<br>
 129                 and drag</td>
 130         </tr>
 131         <tr>
 132                 <td>Jmol Menu</td>
 133                 <td>Right-Click</td>
 134                 <td>Right-Click</td>
 135                 <td>Apple-Click</td>
 136         </tr>
 137 </table>
 138 </p>
 139 <p>The window has up to five menus:
 140 <ul>
 141         <li><Strong>File<br>
 142         </strong>
 143         <ul>
 144                 <li><strong>Save As<br>
 145                 </strong><em>Save the displayed PDB File, or the current view as an EPS or
 146                 PNG file.</em></li>
 147                 <li><strong>View Mapping<br>
 148                 </strong><em> Opens a text window showing the alignment between the
 149                 residues corresponding to alpha-carbon atoms in the PDB structure and
 150                 the residues in the associated sequence.</em></li>
 151         </ul>
 152         </li>
 153         <li><strong>View</strong>
 154         <ul>
 155                 <li><strong>Show Chains<br>
 156                 </strong><em>Select which of the PDB file's chains are to be displayed.</em></li>
 157                 <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>
 158                 <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>
 159                 </li>
 160     <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>
 161   </li>
 162     <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>
 163   </li></ul></li>
 164         <li><strong>Colours<br>
 165         </strong>
 166         <ul>
 167                 <li><strong>By Sequence<br>
 168                 </strong><em> Colours each residue in the structure with the colour of its
 169                 corresponding residue in the associated sequence as rendered in the
 170                 associated alignment views, including any Uniprot sequence features or
 171                 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>
 172                 Residues which only exist in the PDB structure are coloured white if
 173                 they are insertions (relative to the associated sequence in the
 174                 alignment) and grey if they are N or C terminal flanks outside the
 175                 region mapped to the alignment window's sequence.</em></li>
 176                 <li><strong>By Chain<br>
 177                 </strong><em> Assigns a random colour to each PDB chain.</em>
 178                 <li><strong>Charge &amp; Cysteine<br>
 179                 </strong><em> Highlights cysteines in yellow, anionic (Aspartic Acid or
 180                 Glutamic Acid) residues in red, and cationic (Lysine or Arginine)
 181                 residues in blue.</em></li>
 182                 <li><strong>Colour with Jmol<br></strong><em>Defers any colouring operations to Jmol. Select this if you want to use the Jmol scripting interface or menu to modify the view directly.</em></li>
 183                 <li><strong>Standard and User Defined Jalview
 184                 colourschemes.<br>
 185                 </strong><em>The remaining entries apply the colourschemes available from
 186                 the standard and user defined <a href="../colourSchemes/index.html">amino
 187                 acid colours</a>.</em></li>
 188         </ul>
 189         </li>
 190         <li><strong>Jmol<br>
 191         </strong><em>This pulldown menu is only displayed if there are multiple
 192         structures shown in the Jmol window, and Jalview can also locate at
 193         least two of the structures in the currently associated alignment view.</em>
 194         <ul>
 195                 <li><strong><a name="sAlign">Align</a> <br>
 196                 </strong><em> When selected, the associated alignment will be used to
 197                 superimpose all the structures in the view onto the first structure in
 198                 the alignment. The regions used to calculate the superposition will be
 199                 highlighted using the 'Cartoon' rendering style, and the remaining
 200                 data shown as a chain trace.<br>
 201                 (This option was introduced in Jalview 2.6)</em></li>
 202         </ul>
 203         </li>
 204         <li><strong>Help<br>
 205         </strong>
 206         <ul>
 207                 <li><strong>Jmol Help<br>
 208                 </strong><em>Access the Jmol Help documentation in a new browser window.</em></li>
 209         </ul>
 210         </li>
 211 </ul>
 212 </p>
 213 <p><strong>Functionality provided by Jmol</strong></p>
 214 <p>Jmol's own functions are accessed by clicking the 'Jmol' logo or
 215 right-clicking in the structure display area. Either way will open the
 216 Jmol pop-up menu, which provides access to a number of features for
 217 controlling the colour and display of molecules, adding measurements and
 218 labels, plotting surfaces, and display animation. The 'Set Picking' menu
 219 controls the behaviour of single and double mouse clicking on the
 220 structure, and the 'Console' option opens the Jmol scripting console.</p>
 221 <p>The state of each Jmol display is stored within <a
 222         href="jalarchive.html">jalview archives</a> as a Jmol state recovery
 223 script file. This means that any Jmol visualization effects that you add
 224 beyond those provided by Jalview will be able to be stored and recovered
 225 along with the displayed alignments in Jalview.</p>
 226 <p><strong>More Information</strong></p>
 227 <p>Jmol is a sophisticated program in its own right, with its own
 228 command console and scripting language. Only the essentials have been
 229 described here - the interested reader is referred to <a
 230         href="http://jmol.sourceforge.net/docs/">Jmol's own comprehensive
 231 online documentation</a>.</p>
 232 </p>
 233 </body>
 234 </html>