Skip to content

Commit

Permalink
Upload documentation from latest commit
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 20, 2024
1 parent 2b004a2 commit 8b5c02a
Show file tree
Hide file tree
Showing 11 changed files with 15 additions and 14 deletions.
5 changes: 3 additions & 2 deletions _sources/about.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# About the `matchmaps` algorithm

If you want to learn more about the idea behind `matchmaps`, along with some examples, please check out our new pre-print!
If you want to learn more about the idea behind `matchmaps`, along with some examples, please check out paper in the Journal of Applied Crystallography!

> [MatchMaps: Non-isomorphous difference maps for X-ray crystallography](https://www.biorxiv.org/content/10.1101/2023.09.01.555333v2)
> [MatchMaps: non-isomorphous difference maps for X-ray crystallography](https://journals.iucr.org/j/issues/2024/03/00/ei5112/index.html)
If you're looking for a user guide, you can find that [here](quickstart.md). But if you're looking for more details about how `matchmaps` works, read on!

## Abstract

Conformational change mediates the biological functions of macromolecules. Crystallographic measurements can map these changes with extraordinary sensitivity as a function of mutations, ligands, and time. A popular method for detecting structural differences between crystallographic datasets is the isomorphous difference map. Isomorphous difference maps combine the phases of a chosen reference state with the observed changes in structure factor amplitudes to yield a map of changes in electron density. Such maps are much more sensitive to conformational change than structure refinement is, and are unbiased in the sense that observed differences do not depend on refinement of the perturbed state. However, even modest changes in unit cell properties can render isomorphous difference maps useless. This is unnecessary. Here we describe a generalized procedure for calculating observed difference maps that retains the high sensitivity to conformational change and avoids structure refinement of the perturbed state. We have implemented this procedure in an open-source python package, MatchMaps, that can be run in any software environment supporting PHENIX and CCP4. Through examples, we show that MatchMaps "rescues" observed difference electron density maps for poorly-isomorphous crystals, corrects artifacts in nominally isomorphous difference maps, and extends to detecting differences across copies within the asymmetric unit, or across altogether different crystal forms.

## Algorithm overview
Expand Down
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.1.dev1+ge96248f',
VERSION: '0.1.dev1+g6c8d884',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 deletions about.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=72cd6806"></script>
<script src="_static/documentation_options.js?v=9e2b3c46"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down Expand Up @@ -99,9 +99,9 @@

<section class="tex2jax_ignore mathjax_ignore" id="about-the-matchmaps-algorithm">
<h1>About the <code class="docutils literal notranslate"><span class="pre">matchmaps</span></code> algorithm<a class="headerlink" href="#about-the-matchmaps-algorithm" title="Link to this heading"></a></h1>
<p>If you want to learn more about the idea behind <code class="docutils literal notranslate"><span class="pre">matchmaps</span></code>, along with some examples, please check out our new pre-print!</p>
<p>If you want to learn more about the idea behind <code class="docutils literal notranslate"><span class="pre">matchmaps</span></code>, along with some examples, please check out paper in the Journal of Applied Crystallography!</p>
<blockquote>
<div><p><a class="reference external" href="https://www.biorxiv.org/content/10.1101/2023.09.01.555333v2">MatchMaps: Non-isomorphous difference maps for X-ray crystallography</a></p>
<div><p><a class="reference external" href="https://journals.iucr.org/j/issues/2024/03/00/ei5112/index.html">MatchMaps: non-isomorphous difference maps for X-ray crystallography</a></p>
</div></blockquote>
<p>If you’re looking for a user guide, you can find that <a class="reference internal" href="quickstart.html"><span class="std std-doc">here</span></a>. But if you’re looking for more details about how <code class="docutils literal notranslate"><span class="pre">matchmaps</span></code> works, read on!</p>
<section id="abstract">
Expand Down
2 changes: 1 addition & 1 deletion cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=72cd6806"></script>
<script src="_static/documentation_options.js?v=9e2b3c46"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=72cd6806"></script>
<script src="_static/documentation_options.js?v=9e2b3c46"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=72cd6806"></script>
<script src="_static/documentation_options.js?v=9e2b3c46"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
Expand Down
2 changes: 1 addition & 1 deletion quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=72cd6806"></script>
<script src="_static/documentation_options.js?v=9e2b3c46"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion search.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=72cd6806"></script>
<script src="_static/documentation_options.js?v=9e2b3c46"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=72cd6806"></script>
<script src="_static/documentation_options.js?v=9e2b3c46"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
Expand Down
2 changes: 1 addition & 1 deletion visualization.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=72cd6806"></script>
<script src="_static/documentation_options.js?v=9e2b3c46"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand Down

0 comments on commit 8b5c02a

Please sign in to comment.