Skip to content

Commit 0f04e3e

Browse files
authored
[doc] fix RDF equation (and hole link) (#4591)
* [docs] fix normalization in g_ab() RDF equation - doc fix - see #4437 (reply in thread) (originally found by @rodpollet) * [doc] fix missing HOLE link
1 parent 45fb664 commit 0f04e3e

File tree

2 files changed

+3
-1
lines changed
  • package
    • MDAnalysis/analysis
    • doc/sphinx/source/documentation_pages/analysis

2 files changed

+3
-1
lines changed

package/MDAnalysis/analysis/rdf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
3333
.. math::
3434
35-
g_{ab}(r) = (N_{a} N_{b})^{-1} \sum_{i=1}^{N_a} \sum_{j=1}^{N_b}
35+
g_{ab}(r) = \frac{1}{N_{a}} \frac{1}{N_{b}/V} \sum_{i=1}^{N_a} \sum_{j=1}^{N_b}
3636
\langle \delta(|\mathbf{r}_i - \mathbf{r}_j| - r) \rangle
3737
3838
which is normalized so that the RDF becomes 1 for large separations in a

package/doc/sphinx/source/documentation_pages/analysis/hole2.rst

+2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ under the Apache v2.0 license.)
2424
`mdahole2 <https://www.mdanalysis.org/mdahole2/>`_ and
2525
will be removed in MDAnalysis 3.0.0.
2626

27+
.. _HOLE: http://www.holeprogram.org/
28+
2729

2830
See Also
2931
--------

0 commit comments

Comments
 (0)