help/html/features/jmol.html

   1 #-------------------------------------------------------------------------------\r
   2 # Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)\r
   3 # Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
   4 # \r
   5 # This file is part of Jalview.\r
   6 # \r
   7 # Jalview is free software: you can redistribute it and/or\r
   8 # modify it under the terms of the GNU General Public License \r
   9 # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
  10 # \r
  11 # Jalview is distributed in the hope that it will be useful, but \r
  12 # WITHOUT ANY WARRANTY; without even the implied warranty \r
  13 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
  14 # PURPOSE.  See the GNU General Public License for more details.\r
  15 # \r
  16 # You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  17 #-------------------------------------------------------------------------------\r
  18 <html>\r
  19 <!--\r
  20  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)\r
  21  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
  22  * \r
  23  * This file is part of Jalview.\r
  24  * \r
  25  * Jalview is free software: you can redistribute it and/or\r
  26  * modify it under the terms of the GNU General Public License \r
  27  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
  28  * \r
  29  * Jalview is distributed in the hope that it will be useful, but \r
  30  * WITHOUT ANY WARRANTY; without even the implied warranty \r
  31  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
  32  * PURPOSE.  See the GNU General Public License for more details.\r
  33  * \r
  34  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  35 -->\r
  36 <head>\r
  37 <title>The Jmol PDB Viewer</title>\r
  38 </head>\r
  39 <body>\r
  40 <p><strong>The Jmol PDB Viewer</strong>\r
  41 <p>The interactive structure viewing window is opened by selecting\r
  42 the <strong>&quot;Sequence&#8594;View PDB entry:&quot;</strong> entry in\r
  43 the <a href="../menus/popupMenu.html">sequence id pop-up menu</a>. This\r
  44 can only be done for sequences which have an <a href="viewingpdbs.html">associated\r
  45 PDB structure</a>.\r
  46 <p>Since Jalview 2.3, <a href="http://jmol.sourceforge.net/">Jmol</a>\r
  47 has been integrated into Jalview. It is automatically used by the\r
  48 application, and should also run in the applet in all latest web\r
  49 browsers. If jmol is not available, then the original <a\r
  50 href="pdbviewer.html">internal pdb viewer</a> will be used as a fallback.\r
  51 </p>\r
  52 <p><strong>Controls</strong></p>\r
  53 <p>The structure is by default rendered as a ribbon diagram. Moving the\r
  54 mouse over the structure brings up tooltips giving the residue name,\r
  55 PDB residue number and chain code, atom name and number\r
  56 ([RES]Num:Chain.AtomName#AtomNumber). If a mapping exists to a residue\r
  57 in any associated sequences, then this will be highlighted in each\r
  58 one's alignment window. The converse also occurs - moving the mouse\r
  59 over an associated residue in an alignment window highlights the associated\r
  60 atoms in the displayed structures.</p>\r
  61 <p>Selecting a residue highlights its associated sequence residue\r
  62 and alpha carbon location. Double clicking an atom allows distances to\r
  63 be measured from it to any other atom in the structure.</p>\r
  64 <p>\r
  65 <table>\r
  66         <tr>\r
  67                 <td><strong>Action</strong></td>\r
  68                 <td><strong>Windows</strong></td>\r
  69                 <td><strong>Unix</strong></td>\r
  70                 <td><strong>Mac/OSX</strong></td>\r
  71         </tr>\r
  72         <tr>\r
  73                 <td>Rotate View</td>\r
  74                 <td>Left Click and Drag</td>\r
  75                 <td>Left Click and Drag</td>\r
  76                 <td>Click and Drag</td>\r
  77         </tr>\r
  78         <tr>\r
  79                 <td>Zoom</td>\r
  80                 <td>Shift + Left Click<br>drag mouse up or down</td>\r
  81                 <td>Shift + Left Click<br>or middle button<br>drag\r
  82                 mouse up or down</td>\r
  83                 <td>Left-Alt + Click and drag mouse up or down</td>\r
  84         </tr>\r
  85         <tr>\r
  86                 <td>Select/<br>\r
  87                 Deselect<br>\r
  88                 Residue</td>\r
  89                 <td>Left Click</td>\r
  90                 <td>Left Click</td>\r
  91                 <td>Click</td>\r
  92         </tr>\r
  93         <tr>\r
  94                 <td>Roll View</td>\r
  95                 <td>Shift + Left Click<br>drag mouse to left or\r
  96                 right</td>\r
  97                 <td>Shift + Left Click<br>or middle button<br>drag mouse to left or right</td>\r
  98                 <td>Left-Alt + Click and drag mouse to left or right</td>\r
  99         </tr>\r
 100         <tr>\r
 101                 <td>Move Origin</td>\r
 102                 <td>Shift+Control+Left Click<br>or Middle Button<br>\r
 103                 + Drag</td>\r
 104                 <td>Middle-Button<br>and<br>drag</td>\r
 105                 <td>Shift+Control+Left Click<br>or Middle Button<br>\r
 106                 and drag</td>\r
 107         </tr>\r
 108         <tr>\r
 109                 <td>Jmol Menu</td>\r
 110                 <td>Right-Click</td>\r
 111                 <td>Right-Click</td>\r
 112                 <td>Apple-Click</td>\r
 113         </tr>\r
 114 </table>\r
 115 </p>\r
 116 <p>The window has four menus:\r
 117 <ul>\r
 118         <li><Strong>File<br>\r
 119         </strong>\r
 120         <ul>\r
 121                 <li><strong>Save As<br>\r
 122                 </strong><em>Save the displayed PDB File, or the current view as an EPS or PNG file.</em></li>\r
 123                 <li><strong>View Mapping<br>\r
 124                 </strong><em> Opens a text window showing the alignment between the\r
 125                 residues corresponding to alpha-carbon atoms in the PDB structure and\r
 126                 the residues in the associated sequence.</em></li>\r
 127         </ul>\r
 128         </li>\r
 129         <li><strong>View</strong>\r
 130         <ul>\r
 131         <li><strong>Show Chains<br></strong><em>Select which of the PDB\r
 132         file's chains are to be displayed.</em>\r
 133         </li>\r
 134         </ul>\r
 135         <li><strong>Colours<br>\r
 136         </strong>\r
 137         <ul>\r
 138                 <li><strong>By Sequence<br>\r
 139                 </strong><em> Colours each residue in the structure with the colour of its\r
 140                 corresponding residue in the associated sequence as rendered in the\r
 141                 associated alignment view, including any Uniprot sequence features or\r
 142                 region colourings.<br>\r
 143                 Residues which only exist in the PDB structure are coloured white if\r
 144                 they are insertions (relative to the associated sequence in the\r
 145                 alignment) and grey if they are N or C terminal flanks outside the\r
 146                 region mapped to the alignment window's sequence.</em></li>\r
 147                 <li><strong>By Chain<br>\r
 148                 </strong><em> Assigns a random colour to each PDB chain.</em>\r
 149                 <li><strong>Charge &amp; Cysteine<br>\r
 150                 </strong><em> Highlights cysteines in yellow, anionic (Aspartic Acid or\r
 151                 Glutamic Acid) residues in red, and cationic (Lysine or Arginine)\r
 152                 residues in blue.</em></li>\r
 153                 <li><strong>Standard and User Defined Jalview\r
 154                 colourschemes.<br>\r
 155                 </strong><em>The remaining entries apply the colourschemes available from the\r
 156                 standard and user defined <a href="../colourSchemes/index.html">amino\r
 157                 acid colours</a>.</em></li>\r
 158         </ul>\r
 159         </li>\r
 160         <li><strong>Help<br></strong><ul><li><strong>Jmol Help<br></strong><em>Access the Jmol Help\r
 161         documentation in a new browser window.</em>\r
 162         </li>\r
 163         </ul>\r
 164 </li></ul>\r
 165 </p>\r
 166 <p><strong>Functionality provided by Jmol</strong>\r
 167 </p><p>The Jmol menu provides access to a number of features for\r
 168 controlling the colour and display of molecules, adding measurements and\r
 169 labels, plotting surfaces, and display animation. The 'Set Picking'\r
 170 menu controls the behaviour of single and double mouse clicking on the\r
 171 structure.</p>\r
 172 <p>The state of each Jmol display is stored within <a\r
 173 href="jalarchive.html">jalview archives</a> as a jmol state recovery script\r
 174 file. This means that any Jmol visualization effects that\r
 175 you add beyond those provided by Jalview will be able to be stored and\r
 176 recovered along with the displayed alignments in Jalview.\r
 177 </p><p><strong>More Information</strong>\r
 178 </p><p>Jmol is a sophisticated program in its own right, with its own\r
 179 command console and scripting language. Only the essentials have been\r
 180 described here - the interested reader is referred to \r
 181 <a href="http://jmol.sourceforge.net/docs/">Jmol's own comprehensive\r
 182 online documenation</a>.</p></p>\r
 183 </body>\r
 184 </html>\r