JAL-1551 spotlessApply
[jalview.git] / help / help / html / features / viewingpdbs.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>PDB Viewing</title>
24 </head>
25 <body>
26   <p>
27     <strong>Discovering and Viewing PDB and 3D-Beacons structures</strong>
28   </p>
29   Jalview can be used to explore the 3D structures of sequences in an
30   alignment by following the steps below:
31   <ol>
32     <li>Select the <strong>"3D Structure Data..."</strong> option
33       from a sequence's <a href="../menus/popupMenu.html">pop-up
34         menu</a> to open the <a href="structurechooser.html">Structure
35         Chooser</a> dialog box.
36       <ul>
37         <li>If one or more structures exist in the PDB for the given
38           sequence, the <a href="structurechooser.html">Structure
39             Chooser</a> dialog will open with them listed in the results
40           pane.
41         </li>
42         <li>However, if no structure was found, the <a
43           href="structurechooser.html">Structure Chooser</a> interface
44           will present options for manual association of PDB structures.
45         </li>
46         <li>
47           Since Jalview 2.11.2 you can also search the 3D-Beacons Network
48           for structures.  The 3D-Beacons Network acts as a one-stop shop for protein
49           structures by combining and standardising data from several providers.
50           See <a href="structurechooser.html#3dbeaconssearch">3D-Beacons Search</a> for
51           instructions.
52         </li>
53       </ul>
54     </li>
55     <li><strong>Selecting PDB Structures</strong><br />
56       If one or more structures have been found from the PDB, you can select
57       the structures that you want to open and view by selecting them
58       with the mouse and keyboard.<br />By default, if structures were
59       discovered, then some will already be selected according to the
60       criteria shown in the drop-down menu. The default criteria is
61       'highest resolution', simply choose another to pick structures in
62       a different way.<br />
63       <ul>
64         <li><strong>Viewing Cached Structures</strong><br />If
65           previously downloaded structures are available for your
66           sequences, the structure chooser will automatically offer them
67           via the <strong>Cached Structures</strong> view. If you wish
68           to download new structures, select one of the PDBe selection
69           criteria from the drop-down menu.</li>
70       </ul></li>
71     <li><strong>To view selected structures, click the <strong>"View"</strong>
72         button.
73     </strong><br />
74       <ul>
75         <li>Additional structure data will be downloaded with the
76           EMBL-EBI's dbfetch service</li>
77         <li><a href="siftsmapping.html">SIFTS</a> records will also
78           be downloaded for mapping UniProt protein sequence data to PDB
79           coordinates.</li>
80         <li>A new structure viewer will open, or you will be
81           prompted to add structures to existing viewers (see <a
82           href="#afterviewbutton">below</a> for details).
83         </li>
84       </ul></li>
85   </ol>
86   <p>
87     <strong>Structure Viewers in the Jalview Desktop</strong><br /> The
88     <a href="jmol.html">Jmol viewer</a> has been included since Jalview
89     2.3. Jalview 2.8.2 included support for <a href="chimera.html">Chimera</a>,
90     provided it is installed and can be launched by Jalview. ChimeraX and PyMOL
91     support is included from Jalview 2.11.2. The default
92     viewer can be configured in the <a href="preferences.html#structure">Structure
93       tab</a> in the <strong>Tools&rarr;Preferences</strong> dialog box.
94   
95   <p>
96     Structure data imported into Jalview can also be processed to
97     display secondary structure and temperature factor annotation. See
98     the <a href="xsspannotation.html">Annotation from Structure</a> page
99     for more information.
100   </p>
101   <p>
102     <strong><a
103       name="afterviewbutton">Controlling where the new structures
104         will be shown</a></strong>
105     <br/>
106     <img src="schooser_viewbutton.png" />
107         <br />The Structure Chooser offers several options
108     for viewing a structure. <br/>
109     The <strong>Open new structure view</strong> button will open a new
110     structure viewer for the selected structures, but if there are views
111     already open, you can select which one to use, and press the <strong>Add</strong>
112     button. Jalview can automatically superimpose new structures based
113     on the linked alignments - but if this is not desirable, simple
114     un-tick the <strong>Superpose Structures</strong> checkbox.
115
116   </p>
117   <p>
118     <em>Superposing structures</em><br/>Jalview superposes structures using
119     the visible portions of any associated sequence alignments. A
120     message in the structure viewer's status bar will be shown if not
121     enough aligned columns were available to perform a superposition.
122   </p>
123   <p>
124   See the <a href="jmol.html">Jmol
125     </a> and <a href="chimera.html">Chimera</a> help pages for
126       more information about their capabilities.</p>
127   
128
129   <p>
130     <strong>Retrieving sequences from the PDB</strong><br>You can
131     retrieve sequences from the PDB using the <a
132       href="pdbsequencefetcher.html">Sequence Fetcher</a>. The sequences
133     retrieved with this service are derived directly from the PDB 3D
134     structure data, which can be viewed in the same way above. Secondary
135     structure and temperature factor annotation can also be added. <br />
136
137     <br>Jalview will also read PDB files directly - either in PDB
138     format, or <a href="mmcif.html">mmCIF</a>. Simply load in the file
139     as you would an alignment file. The sequences of any protein or
140     nucleotide chains will be extracted from the file and viewed in the
141     alignment window.
142   </p>
143
144   <p>
145     <strong>Associating a large number of PDB files to
146       sequences in an alignment</strong><br /> It is often the case when working
147     with structure alignments that you will have a directory of PDB
148     files, and an alignment involving one or more of the structures. If
149     you drag a number of PDB files onto an alignment in the Jalview
150     desktop, Jalview will give you the option of associating PDB files
151     with sequences that have the same filename. This means, for example,
152     you can automatically associate PDB files with names like '1gaq.pdb'
153     with sequences that have an ID like '1gaq'. <br /> <em>Note:
154       This feature was added in Jalview 2.7</em>
155   </p>
156   <p>
157     <em>Note for Jalview applet users:<br> Due to the applet
158       security constraints, PDB Files can currently only be imported by
159       cut and paste of the PDB file text into the text box opened by the
160       'From File' entry of the structure menu.
161     </em>
162   </p>
163
164   <p>
165     <strong>Viewing the PDB Residue Numbering</strong><br>
166     Sequences which have PDB entry or PDB file associations are
167     annotated with sequence features from a group named with the
168     associated PDB accession number or file name. Each feature gives the
169     corresponding PDB Residue Number for each mapped residue in the
170     sequence. The display of these features is controlled through the <strong>"View&rarr;Sequence
171       Features"</strong> menu item and the <a href="featuresettings.html">Feature
172       Settings dialog box</a>.
173   </p>
174   <br />
175   <hr>
176   <p>
177     <strong>Switching between mmCIF and PDB format for
178       downloading files from the PDB</strong><br /> Jalview now employs the <a
179       href="mmcif.html">mmCIF format</a> for importing 3D structure data
180     from flat file and EMBL-PDBe web-service, as recommended by the
181     wwwPDB. If you prefer (for any reason) to download data as PDB files
182     instead, then first close Jalview, and add the following line to
183     your .jalview_properties file:<br />
184     <code> PDB_DOWNLOAD_FORMAT=PDB </code>
185     <br /> When this setting is configured, Jalview will only request
186     PDB format files from EMBL-EBI's PDBe.<br /> <em>mmCIF format
187       file support was added in Jalview 2.10.</em>
188   </p>
189
190   <p>
191     <em><strong>Outstanding problem with cut'n'pasted
192         files in Jalview 2.6 and Jalview 2.7</strong><br>Structures imported
193       via the cut'n'paste dialog box will not be correctly highlighted
194       or coloured when they are displayed in structure views, especially
195       if they contain more than one PDB structure. See the bug report at
196       http://issues.jalview.org/browse/JAL-623 for news on this problem.</em>
197   </p>
198
199 </body>
200 </html>
201