Documentation/user-guide.txt

   1 HKL Library
   2 ===========
   3 PICCA Frédéric-Emmanuel <picca@synchrotron-soleil.fr>
   4 v2.3.0, September 2007
   5
   6 1. Introduction
   7 ---------------
   8
   9 The purpose of the library is to factories diffraction angles computation for
  10 different kind of diffractometers geometries. It is used at the SOLEIL
  11 synchrotron with the Tango control system to pilot diffractometers.
  12
  13 Features
  14 ~~~~~~~~
  15
  16 - mode computation.
  17   a. for different diffractometer geometries.
  18 - UB matrix computation
  19   a. busing & Levy with 2 reflections
  20   b. simplex computation with more than 2 reflections
  21 - Crystal lattice affinement
  22   a. with more than 2 reflections you can select which parameter must be fitted.
  23 - Pseudoaxes
  24   a. psi, eulerians, q, ...
  25
  26 2. Diffractometers
  27 ------------------
  28
  29 [[two-circles-vertical]]
  30 2.1 Two circles vertical
  31 ~~~~~~~~~~~~~~~~~~~~~~~~
  32
  33 [[eulerian-4-circles-vertical]]
  34 2.2 Eulerian 4 circles vertical
  35 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  36
  37 [[kappa-4-circles-vertical]]
  38 2.3 Kappa 4 circles vertical
  39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  40
  41 [[eulerian-6-circles]]
  42 2.4 Eulerian 6 circles
  43 ~~~~~~~~~~~~~~~~~~~~~~
  44
  45 [[kappa-6-circles]]
  46 2.5 Kappa 6 circles
  47 ~~~~~~~~~~~~~~~~~~~
  48
  49 3. Developpement
  50 ----------------
  51
  52 3.1 Getting hkl
  53 ~~~~~~~~~~~~~~~
  54
  55 To get hkl, you can download the last stable version from sourceforge or if you
  56 want the latest development version use http://git.or.cz/[git] or
  57 http://code.google.com/p/msysgit/downloads/list[msysgit] on windows system and
  58 do
  59
  60 --------------------
  61 git clone git://
  62 --------------------
  63
  64 3.2 Building hkl
  65 ~~~~~~~~~~~~~~~~
  66
  67 To build hkl you need two tools, http://www.scons.org[scons] a make replacement
  68 and the http://sourceforge.net/project/showfiles.php?group_id=11795[cppunit library]
  69 to build the test suit.
  70 If your platform is not supported yet please contact the mailto:picca@synchrotron-soleil.fr[author].
  71
  72 --------------------
  73 scons
  74 --------------------
  75
  76 This command compile the library and the test suit
  77 if everythings go fine you must have a libhkl.a or libhkl.lib in the src directory.
  78
  79