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