Skip to content

Commit

Permalink
[doc] fix RDF equation (and hole link) (#4591)
Browse files Browse the repository at this point in the history
* [docs] fix normalization in g_ab() RDF equation

- doc fix
- see #4437 (reply in thread) (originally found by @rodpollet)

* [doc] fix missing HOLE link
  • Loading branch information
orbeckst committed May 8, 2024
1 parent 45fb664 commit 0f04e3e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion package/MDAnalysis/analysis/rdf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
.. math::
g_{ab}(r) = (N_{a} N_{b})^{-1} \sum_{i=1}^{N_a} \sum_{j=1}^{N_b}
g_{ab}(r) = \frac{1}{N_{a}} \frac{1}{N_{b}/V} \sum_{i=1}^{N_a} \sum_{j=1}^{N_b}
\langle \delta(|\mathbf{r}_i - \mathbf{r}_j| - r) \rangle
which is normalized so that the RDF becomes 1 for large separations in a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ under the Apache v2.0 license.)
`mdahole2 <https://www.mdanalysis.org/mdahole2/>`_ and
will be removed in MDAnalysis 3.0.0.

.. _HOLE: http://www.holeprogram.org/


See Also
--------
Expand Down

0 comments on commit 0f04e3e

Please sign in to comment.