Skip to content

Commit 2fe9f5f

Browse files
committed
docs: add grid information
1 parent 20c6fa9 commit 2fe9f5f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/ess/amor/utils.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,11 @@ def qgrid(
7272
bdlims: BeamDivergenceLimits,
7373
) -> QBins:
7474
'''Generates a suitable Q-binnning from
75-
the limits on wavelength and divergence angle.'''
75+
the limits on wavelength and divergence angle.
76+
77+
The binning is a geometric grid starting from
78+
the minimum achievable Q value or ``1e-3 A``, whichever is larger.
79+
'''
7680
theta_min = (
7781
bdlims[0].to(unit='rad', copy=False)
7882
+ detector_rotation.to(unit='rad', dtype='float64')

0 commit comments

Comments
 (0)