JAL-1620 version bump and release notes
[jalview.git] / help / html / features / viewingpdbs.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
4  * Copyright (C) 2014 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><strong>Viewing PDB Structures</strong></p>
27         <p>
28                 Jalview can view protein structures associated with a sequence via the
29                 <strong>"Structure&rarr;"</strong> submenu from a sequence's <a
30                         href="../menus/popupMenu.html">pop-up menu</a>.
31         </p>
32         The
33         <a href="jmol.html">Jmol viewer</a> has been included since Jalview
34         2.3. Jalview 2.8.2 included support for <a href="chimera.html">Chimera</a>, provided it is
35         installed and can be launched by Jalview. The default viewer can be
36         configured in the
37         <a href="preferences.html#structure">Structure tab</a> in the
38         <strong>Tools&rarr;Preferences</strong> dialog box.
39         <p>
40                 Structure data imported into Jalview can also be processed to display
41                 secondary structure and temperature factor annotation. See the <a
42                         href="xsspannotation.html">Annotation from Structure</a> page for
43                 more information.
44         </p>
45         <p>The following menu entries are provided for viewing structure data<br>
46   <ul>
47     <li>The <strong>&quot;Structure&#8594;View
48         Structure&#8594;</strong> submenu allows a single PDB structure to be chosen
49       for display from the available structures for a sequence.
50     </li>
51     <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
52         structures
53     </strong> option will open a new window containing all structures associated
54       with the current selection, superposed according to the currently selected region of the alignment.<br/><em>This
55       capability was added in Jalview 2.7</em>
56     </li>
57     <li>The <strong>&quot;Structure&#8594;View all <em>N</em>
58         representative structures
59     </strong> option will open a new window containing exactly one structure per
60       currently selected sequence.<br />
61     <em>The View representative structures option was introduced in
62         Jalview 2.8.1</em></li>
63   </ul>
64 </p>
65
66 <p>If a single pdb
67 structure is selected, one of the following will happen:</p>
68
69 <ul>
70         <li>If no structures are open, then an interactive display of the
71         structure will be opened in a new window.</li>
72
73         <li>If another structure is already shown for the current
74         alignment, then you will be asked if you want to add and <a
75                 href="jmol.html#align">align this structure</a> to the structure in
76         the existing view. (<em>new feature in Jalview 2.6</em>).</li>
77
78         <li>If the structure is already shown, then you will be prompted
79         to associate the sequence with an existing view of the selected
80         structure. This is useful when working with multi-domain or multi-chain PDB files.</li>
81
82         <li style="list-style: none">See the <a href="jmol.html">Jmol
83         </a> and <a href="chimera.html">Chimera</a> PDB viewer help pages for more information about the display.</li>
84 </ul>
85         <p><strong>Associating PDB files with Sequences</strong></p>
86         <p>To associate PDB files with a sequence, right click on a sequence
87 ID and select "Structure<strong>&rarr;</strong> Associate Structure with
88 Sequence", and one of the submenus:</p>
89
90 <ul>
91         <li>From File - You can load a PDB file from the local machine or
92         network and associate it with the selected sequence. PDB files
93         associated in this way will also be saved in the <a
94                 href="jalarchive.html">Jalview Archive file</a>.<br>
95         </li>
96
97         <li>Enter PDB Id - Jalview will use WSDBFetch, provided by the
98         EBI, to fetch the PDB file with the entered Id.<br>
99         </li>
100
101         <li>Discover PDB Ids - Jalview uses the sequence's ID to query WSDBFetch, provided by the
102         EBI, and any enabled DAS servers, to discover PDB ids associated with the sequence.</li>
103 </ul>
104
105 <p><strong>Importing PDB Entries or files in PDB format</strong><br>
106 You can retrieve sequences from the PDB using the <a
107         href="seqfetch.html">Sequence Fetcher</a>. Any sequences retrieved with
108 this service are automatically associated with their source database
109 entry. For PDB sequences, simply select PDB as the database and enter
110 your known PDB id (appended with ':' and a chain code, if desired).<br>
111 Jalview will also read PDB files directly. Simply load in the file as
112 you would an alignment file. The sequences of any peptide chains will be
113 extracted from the file and viewed in the alignment window.</p>
114
115 <p>
116 <strong>Associating a large number of PDB files to sequences
117 in an alignment</strong><br /> It is often the case when working with
118 structure alignments that you will have a directory of PDB files, and
119 an alignment involving one or more of the structures. If you drag a
120 number of PDB files onto an alignment in the Jalview desktop, Jalview
121 will give you the option of associating PDB files with sequences that
122 have the same filename. This means, for example, you can automatically
123 associate PDB files with names like '1gaq.pdb' with sequences that
124 have an ID like '1gaq'.
125 <br/><em>Note: This feature was added in Jalview 2.7</em>
126 </p>
127 <p><em>Note for jalview applet users:<br>
128 Due to the applet security constraints, PDB Files can currently only be
129 imported by cut and paste of the PDB file text into the text box opened
130 by the 'From File' entry of the structure menu.</em></p>
131
132 <p><strong>Viewing the PDB Residue Numbering</strong><br>
133 Sequences which have PDB entry or PDB file associations are annotated
134 with sequence features from a group named with the associated PDB
135 accession number or file name. Each feature gives the corresponding PDB
136 Residue Number for each mapped residue in the sequence. The display of
137 these features is controlled through the <strong>"View&rarr;Sequence
138 Features"</strong> menu item and the <a href="featuresettings.html">Feature
139 Settings dialog box</a>.</p>
140
141 <p><em><strong>Outstanding problem with cut'n'pasted
142 files in Jalview 2.6 and Jalview 2.7</strong><br>
143 Structures imported via the cut'n'paste dialog box will not be correctly
144 highlighted or coloured when they are displayed in structure views,
145 especially if they contain more than one PDB structure. See the bug
146 report at http://issues.jalview.org/browse/JAL-623 for news on this problem.</em></p>
147 </body>
148 </html>
149