Skip to content

Commit 5deb6cf

Browse files
committed
Use the same name as in equation
1 parent b1f3797 commit 5deb6cf

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

  • packages/essdiffraction/src/ess/diffraction

packages/essdiffraction/src/ess/diffraction/pdf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ def pair_correlation_function(
8282
8383
Returns
8484
-------
85-
g: scipp.DataArray
85+
G: scipp.DataArray
8686
1D array representing :math:`G(r)` with a bin-edge coordinate called
8787
``'r'`` that is the provided output grid.
8888
cov: scipp.DataArray
@@ -117,7 +117,7 @@ def pair_correlation_function(
117117

118118

119119
def pair_distribution_function(
120-
g: sc.DataArray, *, atomic_density: sc.Variable
120+
G: sc.DataArray, *, atomic_density: sc.Variable
121121
) -> sc.DataArray:
122122
r"""Compute the pair distribution function from a pair correlation function.
123123
@@ -136,7 +136,7 @@ def pair_distribution_function(
136136
137137
Parameters
138138
----------
139-
g:
139+
G:
140140
:func:`Pair correlation function <pair_correlation_function>` :math:`G(r)`.
141141
atomic_density:
142142
The atomic density :math:`\rho` of the material.
@@ -151,7 +151,7 @@ def pair_distribution_function(
151151
ess.diffraction.pdf:
152152
Module with related functions.
153153
"""
154-
return 1 + g / (4 * sc.constants.pi * atomic_density * sc.midpoints(g.coords['r']))
154+
return 1 + G / (4 * sc.constants.pi * atomic_density * sc.midpoints(G.coords['r']))
155155

156156

157157
def radial_distribution_function(

0 commit comments

Comments
 (0)