Skip to content

Commit 265fdc6

Browse files
committed
Added warning to pcf code
1 parent a2dfd5f commit 265fdc6

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

exatomic/algorithms/pcf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ def radial_pair_correlation(universe, a, b, dr=0.05, start=1.0, stop=13.0,
6868
the volume sampled during computation of two body properties divided by
6969
the number of properties used in the histogram (the triple summation
7070
above, divided by the normalization for the radial distance outward).
71+
72+
Warning:
73+
Using a start and stop length different from 0 and simple cubic cell dimension
74+
will cause the y axis magnitudes to be inaccurate. This can be remedied by
75+
rescaling values appropriately.
7176
"""
7277
bins = np.arange(start, stop, dr) # Discrete values of r for histogram
7378
if isinstance(a, str):

0 commit comments

Comments
 (0)