JAL-3858 JAL-3855 documentation for import and display PAE from alphafold and JSON...
[jalview.git] / help / help / html / features / paematrices.html
diff --git a/help/help/html/features/paematrices.html b/help/help/html/features/paematrices.html
new file mode 100644 (file)
index 0000000..cebc16b
--- /dev/null
@@ -0,0 +1,65 @@
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<head>
+<title>Working with PAE Matrices in Jalview</title>
+</head>
+
+<body>
+       <p>
+               <strong>Working with Predicted Alignment Error Matrices in
+                       Jalview</strong>
+       </p>
+
+       <p>Predicted Alignment Error matrices are produced by deep-learning
+               based 3D-structure prediction pipelines such as AlphaFold.</p>
+       <p>
+               Jalview retrieves PAE matrices when importing predicted 3D structures
+               from the EBI-AlphaFold database via <a
+                       href="../features/structurechooser.html">Jalview's structure
+                       chooser</a> GUI.
+       </p>
+       <p>
+               If you have produced your own models using a pipeline such as
+               ColabFold, then you can load it via the 'Add PAE matrix file' button
+               in the <a href="../features/structurechooser.html#loadpdbfile">Load
+                       PDB File</a> dropdown menu in the 3D structure chooser, providing it is
+               in a <a href="../io/paematrixformat.html">supported PAE format</a>. ,
+               or the <a href="../features/clarguments-basic.html">Command Line
+                       Interface</a>. See <a href="../features/paematrices.html">Working
+                       with PAE Matrices</a> for information on how they are visualised and
+               analysed in Jalview.
+       </p>
+       </p>
+       <p>
+               An additional <em>Predicted Alignment Error</em> file can also be
+               provided when importing 3D structure data. Jalview supports import of
+               PAE Matrices provided as <a href="../io/paematrixformat.html">AlphaFold
+                       format JSON files</a> - which are also produced by ColabFold. See <a
+                       href="paematrices.html">Working with PAE Matrices</a> for details on
+               what Jalview allows you to do with associated PAE matrix data.
+       </p>
+       <p>
+               <em>The Structure Chooser interface was introduced in Jalview
+                       2.9. </em>
+       </p>
+</body>
+</html>