Skip to content

Commit 8e7e2eb

Browse files
committed
DOC #14
1 parent e02c052 commit 8e7e2eb

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

docs/source/concepts.rst

+15-9
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ coordinate space updates the coordinates of the other space. For
2424
diffractometers, the orientation matrix ($UB$) enables transformation between the
2525
two spaces.
2626

27-
.. note:: A monochromatic [#]_ radiation source is expected.
27+
.. note:: A monochromatic [#]_ radiation source is expected. See
28+
:ref:`concepts.wavelength` for more details.
2829

2930
.. rubric:: Coordinates
3031

@@ -33,18 +34,23 @@ two spaces.
3334
:reals:
3435
Positioners (rotation motors) in physical coordinates.
3536

36-
An ophyd *PseudoPositioner* transforms between *pseudos* and *reals*
37-
with the :meth:`~hklpy2.diffract.DiffractometerBase.forward()` and
37+
An ophyd *PseudoPositioner* relies on the
38+
:meth:`~hklpy2.diffract.DiffractometerBase.forward()` and
3839
:meth:`~hklpy2.diffract.DiffractometerBase.inverse()` methods.
3940

4041
.. rubric:: Transformations
4142

42-
========== ========= ============== ======== ================
43-
from to transformation solution implementation
44-
========== ========= ============== ======== ================
45-
*reals* *pseudos* transformation unique :meth:`~hklpy2.diffract.DiffractometerBase.inverse()`
46-
*pseudos* *reals* transformation many :meth:`~hklpy2.diffract.DiffractometerBase.forward()`
47-
========== ========= ============== ======== ================
43+
========== ========= ============== ================
44+
from to solution(s) transformation
45+
========== ========= ============== ================
46+
*reals* *pseudos* 1 :meth:`~hklpy2.diffract.DiffractometerBase.inverse()`
47+
*pseudos* *reals* 0, 1, or more :meth:`~hklpy2.diffract.DiffractometerBase.forward()`
48+
========== ========= ============== ================
49+
50+
A |solver| provides support for one or more diffractometer geometries. Each
51+
geometry has a specific set of *pseudos*, *reals*, and other terms which support
52+
the ``forward()`` and ``inverse()`` transformations. See
53+
:ref:`concepts.solvers` for more details.
4854

4955
.. seealso:: :ref:`glossary`
5056

hklpy2/backends/hkl_soleil.py

-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
:doc:`../../examples/hkl_soleil-e6c-psi`.
2626
2727
.. autosummary::
28-
:platform: Unix
2928
3029
~HklSolver
3130
"""

0 commit comments

Comments
 (0)