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