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