[doc] Added TODO's for binoculars-ng
[hkl.git] / NEWS
blobf20963781a172774c74b39063c77d871c5d24fd0
1 # -*- org -*-
3 * 5.0.0 UNRELEASED
4 ** General
5    - 5.x runtime can be co-installed with the 4.x series.
6    - hkl.h contain all the Public API.
7    - A clear separation between the public and private API was
8      achieved, in order to propose a Long Time Support of the
9      5.x series.
10    - c-tap-hardness library was embeded to provide the unit test
11      framework.
12    - gobject-instrospection provide the binding support. Look at this
13      [[https://wiki.gnome.org/action/show/Projects/GObjectIntrospection][page]] for more informations.
14    - Documentation was generated with org-mode and asymptote for the figures.
15    - New diffractometers added
16      - E4CH (eulerian 4 circles horizontal) geometry.
17      - MARS beamline (SOLEIL) eulerian 4 circles vertical geometry.
18      - SOLEIL SIRIUS KAPPA
19      - SOLEIL SIRIUS TURRET
20    - New Pseudo Axes engines.
21      - qper_qpar
22    - A not yet public hkl3d library used only by the gui allow to
23      compute (Bullet) and display (OpenGL) collision for model
24      described using the COLLADA file format.
25    - all private symbols are now hidden.
26 ** Buildsystem
27    - add a --disable-hkl3d flag to avoid hkl3d library compilation.
28    - replace the --enable-ghkl with a --disable-gui.
29    - use ./configure --help for all the options
30 ** Gui
31    - Rewriten using Gtk instead of Gtkmm, in order to minimise the
32      required dependencies.
33    - Added a 3D view to display diffractometers and collisions.
34    - Added the K6C 3D model.
35 ** Bindings
36    - Provide the garantie via unit tests that the python API will be
37      stable during all the 5.x lifetime.
38    - For other languages look at [[https://wiki.gnome.org/Projects/GObjectIntrospection/][here]].
40 * 4.0.4 UNRELEASED
41         * add the SOLEIL SIXS MED2+2 diffractometer
42           - engine: hkl
43             - mode: reflectivity.
44           - engine: qper_qpar
45         * add the SOLEIL MARS diffractometer
46           - engine: qper_qpar
47         * add the PETRA3 P09 EH2 diffractometer
48           - engine: qper_qpar
49         * modified E6C
50           - engine: qper_qpar
51           - add modes : hkl psi_constant_horizontal, constant_mu_horizontal
52         * K6C
53           - engine hkl:
54             - add the constant_incidence mode
55           - engine: qper_qpar
56         * add the sphinx documentation
58 * 4.0.3 06-06-2010
59         * remove the usage.c file to avoid a GPL2-GPL3+ incompatibility
60         * update the documentation
61         * fix warning catched by clang
63 * 4.0.2 01-06-2010
64         * add the ghkl manpage and .desktop file
65         * fix the ghkl quit menuitem bugs
67 * 4.0.1 10-05-2010
68         * fix a few ghkl bugs (.ui files installation)
69         * add a --enable-ghkl=[yes,no] flag to allow compiling the gui interface
70         * do not forgot to link ghkl against gsl.
71         * display by default the preference panel of ghkl.
73 * 4.0.0 14-04-2010
75         * add the autotools buildsystem and remove all other systems.
76         * add a GUI ghkl for testing purpose based on gtkmm.
77         * add the GNU info doc
78         * add the gtk-doc to document the api (work in progress)
79         * new structure for the HklDetector (prepare for 2D detectors)
80         * HklGeometryConfig shared between all equivalent HklGeometries.
81         * fix for 64 bits computers runtime error.
82         * add the GError class to report calculation errors (not yet used)
83         * new way to set the UB matrix of a sample (hkl_sample_set_UB).
84         * new ZAxis geometry
85                 - mode zaxis
86                 - mode reflectivity (mu = gamma)
88 * 3.0.1 23-10-2009
90         * add the psi_constant mode to the e4cv, e6c, k4cv and k6c geometries. (thanks teresa)
91         * upgrade the user guide to explain how to add a mode.
92         * the horizontal modes are also valid if omega = +-PI. (e6c, k6c)
93         * remove geometries with an invalid range from the list of solutions.
95 * 3.0.0 15-07-2009
97         * Rewrote from scratch in C with the GSL library.
98                 - now most of pseudo axes modes are numeric.
99                   So a 6 circles mode is now a real 6 circles mode.
100         * Eulerian 4 circles
101                 - PseudoAxisEngine  "hkl": "h", "k", "l"
102                         * Mode "bissector"
103                         * Mode "constant_omega"
104                         * Mode "constant_chi"
105                         * Mode "constant_phi"
106                         * Mode "double_diffraction"
107                 - PseudoAxisEngine "psi": "psi"
108                         * Mode "psi"
109         * Kappa 4 circles
110                 - PseudoAxisEngine  "hkl": "h", "k", "l"
111                         * Mode "bissector"
112                         * Mode "constant_omega"
113                         * Mode "constant_chi"
114                         * Mode "constant_phi"
115                         * Mode "double_diffraction"
116                 - PseudoAxisEngine "psi": "psi"
117                         * Mode "psi"
118                 - PseudoAxisEngien "eulerians": "omega", "chi", "phi"
119                         * mode "eulerians"
120         * Eulerian 6 circles
121                 - PseudoAxisEngine  "hkl": "h", "k", "l"
122                         * Mode "bissector_vertical"
123                         * Mode "constant_omega_vertical"
124                         * Mode "constant_chi_vertical"
125                         * Mode "constant_phi_vertical"
126                         * Mode "double_diffraction_vertical"
127                         * Mode "lifting_detector"
128                         * Mode "bissector_horizontal"
129                         * Mode "double_diffraction_horizontal"
130                 - PseudoAxisEngine "psi": "psi"
131                         * Mode "psi"
132         * Kappa 6 circles
133                 - PseudoAxisEngine  "hkl": "h", "k", "l"
134                         * Mode "bissector_vertical"
135                         * Mode "constant_omega_vertical"
136                         * Mode "constant_chi_vertical"
137                         * Mode "constant_phi_vertical"
138                         * Mode "double_diffraction_vertical"
139                         * Mode "lifting_detector"
140                         * Mode "bissector_horizontal"
141                         * Mode "constant_phi_horizontal"
142                         * Mode "constant_kphi_horizontal"
143                         * Mode "double_diffraction_horizontal"
144                 - PseudoAxisEngine "psi": "psi"
145                         * Mode "psi"
146                 - PseudoAxisEngien "eulerians": "omega", "chi", "phi"
147                         * mode "eulerians"
149 * 2.3.0 24-01-2007
151     * Refactoring of the sample part.
152       - It is now possible to create different kind of samples easily.
153         - MonoCrystal type.
155     * Diffractometers:
156       - Eulerian 6 Circles.
157       - kappa 4 Circles Vertical.
159     * Refactoring of the PseudoAxe part.
160       - Derived PseudoAxe can be created from an already existing PseudoAxe if the Geometry conversion exist.
161       - Better related PseudoAxes (ex Eulerians on a Kappa)
162       - The PseudoAxe is just a interface, computation is done by the PseudoAxeEngine.
163       - Eulerian 4 Circles Vertical
164         - "th2th" : derived from the twoC
165         - "q2th" : derived from the twoC
166         - "q" : derived from the twoC
167       - kappa 4 Circles Vertical
168         - "omega", "chi", "phi" : eulerian 4 circles Vertical pseudoAxes.
169         - "th2th" : derived from the twoC
170         - "q2th" : derived from the twoC
171         - "q" : derived from the twoC
172         - "psi" : derived from the Eulerian 4 Circlers Vertical.
173       - Eulerian 6 Circles:
174         - "tth" : 2 * theta
175         - "q" : 2 * tau * sin(theta) / lambda
176         - "psi" : derived from the Eulerian 4 Circlers Vertical.
177       - Kappa6C
178         - "omega", "chi", "phi" : derived from the Kappa 4 Circles Vertical.
179         - "tth" derived from the Eulerian6C.
180         - "q" derived from the Eulerian6C.
181         - "psi" : derived from the Eulerian 4 Circlers Vertical.
183     * Refactoring of the Modes.
184       - Derived Mode can be created from an already existing Mode if the Geometry conversion exist.
185       - all Eulerian 4 Circles on the kappa4C, Eulerian6c and Kappa6C diffractometers.
187 * 2.2.0 19-06-2006
189     * Diffractometers:
190       - twoC Vertical.
191       - Eulerian 4 Circles Vertical.
192       - Kappa 6 Circles.
194     * PseudoAxes
195       - twoC
196         - "th2th": omega - 2theta (domega = d2theta / 2)
197         - "q2th" : omega - 2theta (domega = d2theta / 2) but q2th = 2 tau sin(theta) / lambda
198         - "q" : 2 * tau * sin(theta) / lambda
199       - Eulerian 4 Circles Vertical
200         - "th2th": omega - 2theta (domega = d2theta / 2)
201         - "q2th" : omega - 2theta (domega = d2theta / 2) but q2th = 2 tau sin(theta) / lambda
202         - "q" : 2 * tau * sin(theta) / lambda
203         - "psi" : Rotation of the sample oaround the Q vector.
205     * Modes
206       - twoC
207         - "symetric" (omega = theta, 2theta = 2 * theta)
208         - "fix incidence" (omega = free, 2theta = 2 * theta)
209       - Eulerian 4 circles:
210         - "Bissector"
211         - "Delta Theta"
212         - "Constant Omega"
213         - "Constant Chi"
214         - 'Constant Phi"
215       - Kappa6C
216         - all Eulerian 4 Circles modes.