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