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