source: sasview/installers/README.txt @ aa1e5a69

magnetic_scattrelease-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249unittest-saveload
Last change on this file since aa1e5a69 was aa1e5a69, checked in by Paul Kienzle <pkienzle@…>, 6 years ago

fix merge

  • Property mode set to 100644
File size: 43.4 KB
Line 
1Release Notes
2=============
3
41- Features
5===========
6    - New in Version 4.2.0
7      --------------------
8      This release heralds many improvements and a host of bug fixes, along with
9      some significant changes from previous versions. Further, as promised, it
10      marks the end of support for 32 bit operating systems and is only
11      available for 64 bit operating systems.
12
13      With this version the change to the new model API and plugins infrastructure
14      begun with 4.0 is essentially complete (though extensions are in the works
15      and more are likely they should remain backwardly compatible with previous
16      versions of SasView).
17
18      NOTE: Old-style plugin models, including old sum|multiply models will continue
19      to be supported (i.e. SasView will be able to run them) in 4.x. However,
20      the expectation is that such support will be removed in 5.0 and everyone
21      is strongly encouraged to convert their custom models to the new API.
22
23      Finally, the changes to orientation angles and orientational distribution
24      definitions are now also complete.
25
26      - Changes
27         - The infrastucture for calculating 2D patterns from 3D orientated objects
28           has been totally re-factored. It is now more accurate and consistent
29           across models.
30         - The way that SasView defines the orientation of anisometric and
31           aligned objects has been completely overhauled. It now differs from
32           previous versions.
33         - Plugin models, including sum/multiply models, have completely migrated
34           to the new infrastructure. NOTE that 3.x type models as well as early,
35           intermediate 4.x type models, including those generated by sum|multiply
36           will continue to be supported in 4.x but will likely no longer be
37           supported after the move to 5.0.  Users are strongly encouraged to
38           migrate any custom models.
39         - The NeXus loader has been removed as it is superseded by the NXcanSAS
40           standard loader and SasView does not support the treatment of raw
41           data.
42      - Improvements
43         - The accuracy/speed of some numerical integrations have been improved.
44         - An orientation viewer tool has been introduced to assist in
45           understanding the new orientation framework.
46         - Problems with the computation of magnetic scattering from some
47           objects have been rectified. Some questions remain however.
48         - The known issue with the core_shell_parallelepiped model is now fixed.
49         - A number of issues and inconsistencies with the creation of
50           sum|multiply models have been rectified.
51         - A Boltzmann distribution has been added for polydispersity/orientational
52           distributions.
53         - Some batch slicing options have been introduced.
54         - Correlation function analysis now computes both the 1D and 3D functions.
55         - There are several data loading improvements.
56         - There are several improvements to Save/Load Project.
57         - There have been numerous other bug fixes.
58      - Documentation
59           Several sections of the help documentation have undergone significant
60           checking and updating, particularly those relating to orientation,
61           magnetic scattering, and polydispersity distributions. Detailed
62           advanced instructions for plugin writing and some scripting
63           instructions have been added.
64      - Other work
65         - A Third-Party initiative has recently succeeded in getting SasView to
66           run on Debian. More details at
67           http://trac.sasview.org/wiki/DevNotes/Projects/Debian
68         - With this release we have started to prepare for the inevitable move
69           to Python 3, which will occur with the release of 5.0
70         - SasView 5.0 is currently in development. The two most significant
71           features of this version will be (i) a move away from the present
72           WxPython GUIs to new, completely rewritten, Qt5 GUIs, and
73           (ii)implementation of the Beta-approximation for S(Q). Subject to
74           resources, some limited access to the latter functionality may be
75           available in a future SasView 4.x release.
76      - Bug Fixes
77         Fixes # 260: Box integration does not update when entering values in dialog
78         Fixes # 446: Saving plot as PGF (not PDF!) format throws error
79         Fixes # 467: Extend batch functionality to slicer
80         Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly
81                      (USANS slit smearing)
82         Fixes # 499: create sin(x)/x, 2*J1(x)/x and 3*j1(x)/x functions
83         Fixes # 510: Build PDF documentation along with HTML
84         Fixes # 525: Add GUI category defaults to models in sasmodels
85         Fixes # 579: clean up sasview directory
86         Fixes # 597: Need to document Combine Batch Fit
87         Fixes # 645: GUI logic problem in Batch vs single fit mode
88         Fixes # 648: Need to allow user input background value in Pr perspective
89         Fixes # 685: Fix data upload to marketplace
90         Fixes # 695: linear slope in onion model
91         Fixes # 735: Review new Corfunc documentation
92         Fixes # 741: Recalculate P(Q) and S(Q) components on model update.
93         Fixes # 767: Sum/Product Models don't do what they should
94         Fixes # 776: angular dispersity
95         Fixes # 784: Add 3D integral to Correlation Function analysis
96         Fixes # 786: core_shell_parallelepiped 1-D model is incorrect
97         Fixes # 818: "report button" followed by "save" makes an empty pdf file
98         Fixes # 838: Fix model download from marketplace
99         Fixes # 848: can't save analysis when only one fit page
100         Fixes # 849: Load Folder should ignore files starting with .
101         Fixes # 852: More unit tests, especially for oriented or 2d models
102         Fixes # 854: remove unnecessary sleep() in fitting perspective
103         Fixes # 856: Reading SAS_OPENCL from custom_config sometimes raises an ERROR
104         Fixes # 861: cannot defined a structure factor plugin
105         Fixes # 864: New Model Editor (simple plugin editor) error parsing
106                      parameter line
107         Fixes # 865: Plugin live discovery issues
108         Fixes # 866: inform user when NaN is returned from compute
109         Fixes # 869: fit page computation thread cleanup
110         Fixes # 875: Possible weirdness with 1D NXcanSAS data
111         Fixes # 876: Add check for HDF5 format in dataloader
112         Fixes # 887: reorganize tree, separating the installed source from the
113                      build source
114         Fixes # 889: Refactor dataloader error handling infrastructure
115         Fixes # 890: use new orientation definition for asymmetric shapes
116         Fixes # 891: update docs for oriented shapes with new orientation definition
117         Fixes # 896: equations in core shell parallelepiped docs do not match code
118         Fixes # 898: Image Viewer Tool file selector issue
119         Fixes # 899: Igor Reader q calculation
120         Fixes # 902: IgorReader Q calculation needs fixing/improving
121         Fixes # 903: sasview - all non-gui tests should be converted to run in Python 3
122         Fixes # 906: polydispersity not showing up in tabulated results
123         Fixes # 912: About box points to misleading contributors page on Github
124         Fixes # 915: load project issues
125         Fixes # 916: Proper Logging
126         Fixes # 920: Logarithmic binning option in the slice viewer
127         Fixes # 921: Improve developer communication methods
128         Fixes # 922: Remove support for all data formats that are not in q space
129         Fixes # 923: Add CI and trac integrations to Slack
130         Fixes # 930: fitting help says chisq is normalized to number of points
131         Fixes # 931: Allow admins to edit all models and upload data etc on
132                      marketplace
133         Fixes # 932: Need to fix upload of data files to marketplace
134         Fixes # 934: Slurp tutorial repo for tutorials
135         Fixes # 935: Build new tutorials as PDF
136         Fixes # 943: Deep copy error on setting model after data is selected
137         Fixes # 950: Most of the readers don't close files properly.
138         Fixes # 954: cross check dll/opencl/python polydispersity and
139                      orientation results
140         Fixes # 956: Possible problem with new doc build process
141         Fixes # 961: sasmodels tests should fail if the parameter name does not exist
142         Fixes # 962: star polymer typo in docs
143         Fixes # 967: no uncertainties errors on fitting parameters
144         Fixes # 969: About Box not picking up dls_logo.png
145         Fixes # 970: ASCII loader doesn't handle ISIS 2D ASCII
146         Fixes # 974: blacklist Intel HD 620/630 for double precision
147         Fixes # 978: load project fails for pages which have not been defined
148         Fixes # 983: Remove Nexus Loader
149         Fixes # 984: PDF reports are not being properly generated on Windows
150         Fixes # 985: Saving Project Fails
151         Fixes # 986: Send to fitting overwrites theory page even if blank
152                      FitPage has focus
153         Fixes # 990: utest_sasview.py giving different results than run_one.py
154         Fixes # 993: Windows x64 versions not installing to correct folder
155         Fixes # 994: Error changing fit engine
156         Fixes # 995: OpenCL required on Linux even if turned off in GUI
157         Fixes #1006: multiplicity models don't work with SQ
158         Fixes #1007: spherical_sld model freezes SasView
159         Fixes #1008: plugin model scaling not working? S
160         Fixes #1010: Win64 build script not creating working executable
161         Fixes #1011: sld_test failing on ubuntu
162         Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded
163                      multiple times
164         Fixes #1018: add Boltzmann distribution
165         Fixes #1021: add PDF documentation to website and document in wiki
166                      release process
167         Fixes #1024: Update version numbers in master
168         Fixes #1025: Sum/multiply editor hangs
169         Fixes #1032: convert C++ modules to C
170         Fixes #1035: Order of combining P(Q) and S(Q) in Plugins seems to matter
171         Fixes #1037: data loader crop not working? & all fits crashing
172         Fixes #1043: problem compiling marketplace models
173         Fixes #1050: fix appveyor test for sasmodels win 64 python 3
174         Fixes #1052: Can't use a user-created plugin model in a plugin model
175         Fixes #1057: phi rotation issue for elliptical cylinder
176         Fixes #1060: incorrect default for rectangle dispersion
177         Fixes #1062: win32 build not installing correctly
178         Fixes #1064: Fitting did not converge!!! error with a Sum|Multi plugin model
179         Fixes #1069: GUI problem when using polydispersity/orientation distributions
180         Fixes #1070: Parameter error boxes should not be editable
181         Fixes #1079: Remove save button in report dialog on Mac
182         Fixes #1081: GUI problem with new orientation distribution
183         Fixes #1083: Magnetic models not being computed
184         Fixes #1099: Erratic behaviour of Sum|Multi model in 4.1.2
185         Fixes #1101: Batch results page not displaying polydispersity values
186         Fixes #1131: OpencCl dialog does not open
187         Fixes #1132: Slit Size Calculator Tool not working
188         Fixes #1139: Missing Docs and Help for new Batch Slicing
189         Fixes #1141: Intro to scripting.rst needs improvement
190         Fixes #1142: Plugin framework is broken
191         Fixes #1044: Unable to upload c file to marketplace
192         Fixes #1145: Update models in model marketplace to 4.2 when 4.2 is released.
193         Fixes #1148: Documentation for S(Q) models need updating
194         Fixes #1128: AutoPlot generation for model documentation does not
195                      include background
196
197      It is recommended that all users upgrade to this version, but your
198      attention is drawn to the Changes section above.
199
200    - New in Version 4.2.0-Beta
201      -------------------------
202      This is a beta pre-release version of 4.2.0.  A number of fixes and changes
203      have been made in the year since the previous release. Full release notes
204      will be compiled prior to the full release 4.2.0.
205
206      Highlights are:
207        - Infrastucture for calculating 2D patterns from 3D orientated objects
208          has now been totally refactored
209        - Plugins have completely migrated to the new infrastructure now,
210          including sum/multiply models
211        - Some batch slicing options have been introduced
212        - The known issue with the core_shell_parallelepiped is now fixed
213        - Several data loading improvements
214        - Several save Project improvements (though there are more to come)
215        - Numerous bug fixes
216        - Lots of documentation enhancement
217
218      In the meantime please report any bugs or issues found while using this beta
219
220
221    - New in Version 4.1.2
222      --------------------
223      This point release is a bug-fix release addressing:
224
225       - Fixes #984: PDF Reports Generate Empty PDFs
226       - Fixes a path typo
227       - 64 bit and 32 bit Windows executables now available
228
229      It is recommended that all users upgrade to this version
230
231    - New in Version 4.1.1
232      --------------------
233      This point release is a bug-fix release addressing:
234
235       - Fixes #948: Mathjax CDN is going away
236       - Fixes #938: Cannot read canSAS1D file output by SasView
237       - Fixes #960: Save project throws error if empty fit page
238       - Fixes #929: Problem deleting data in first fit page
239       - Fixes #918: Test folders not bundled with release
240       - Fixes an issue with the live discovery of plugin models
241       - Fixes an issue with the NXcanSAS data loader
242       - Updated tutorials for SasView 4.x.y
243
244    - New in Version 4.1.0
245      ------------------
246      This incremental release brings a series of new features and improvements,
247      and a host of bug fixes. Of particular note are:
248
249      - Correlation Function Analysis (Corfunc)
250        This performs a correlation function analysis of one-dimensional SAXS/SANS data,
251        or generates a model-independent volume fraction profile from the SANS from an
252        adsorbed polymer/surfactant layer.
253
254        A correlation function may be interpreted in terms of an imaginary rod moving
255        through the structure of the material. G1(R) is the probability that a rod of
256        length R moving through the material has equal electron/neutron scattering
257        length density at either end. Hence a frequently occurring spacing within a
258        structure manifests itself as a peak.
259
260        A volume fraction profile \Phi(z) describes how the density of polymer
261        segments/surfactant molecules varies with distance from an (assumed locally flat)
262        interface.
263
264      - Fitting of SESANS Data
265        Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will
266        be plotted against the correct axes and models will automatically perform a Hankel
267        transform in order to calculate SESANS from a SANS model.
268
269      - Documentation
270        The documentation has undergone significant checking and updating.
271
272      - Improvements
273        - Correlation function (corfunc) analysis of 1D SAS data added from CCP13
274        - File converter tool for multi-file single column data sets
275        - SESANS data loading and direct fitting using the Hankel transformation
276        - Saving and loading of simultaneous and constrained fits now supported
277        - Save states from SasView v3.x.y now loaded using sasmodel model names
278        - Saving and loading of projects with 2D fits now supported
279        - Loading a project removes all existing data, fits, and plots
280        - Structure factor and form factor can be plotted independently
281        - OpenCL is disabled by default and can be enabled through a fit menu
282        - Data and theory fields are now independently expandable
283      - Bug Fixes
284        - Fixes #667: Models computed multiple times on parameters changes
285        - Fixes #673: Custom models override built in models of same name
286        - Fixes #678: Hard crash when running complex models on GPU
287        - Fixes $774: Old style plugin models unloadable
288        - Fixes #789: stacked disk scale doesn't match cylinder model
289        - Fixes #792: core_shell_fractal uses wrong effective radius
290        - Fixes #800: Plot range reset on plot redraws
291        - Fixes #811 and #825: 2D smearing broken
292        - Fixes #815: Integer model parameter handling
293        - Fixes #824: Cannot apply sector averaging when no detector data present
294        - Fixes #830: Cansas HDF5 reader fully compliant with NXCanSAS v1.0 format
295        - Fixes #835: Fractal model breaks with negative Q values
296        - Fixes #843: Multilayer vesicle does not define effective radius
297        - Fixes #858: Hayter MSA S(Q) returns errors
298        - Numerous grammatical and contexual errors in documention
299
300
301    - New in Version 4.0.1
302      ------------------
303      This release fixes the critical bug #750 in P(Q)*S(Q).  Most damaging
304      it appears that the background term was being added to S(Q) prior to
305      multiplication by P(Q).
306
307
308    - New in Version 4.0
309      ------------------
310      This release fixes the various bugs found during the alpha and beta testing
311      - Improvements
312        - Support for reading data files from Anton Paar Saxess instruments
313        - Adds documentation on how to write custom models in the new framework
314      - Bug Fixes
315        - Fixes bug #604 Pringle model questions
316        - Fixes bug #472 Reparameterize Teubner-Strey
317        - Fixes bug #530 Numerical instabilities in Teubner Strey model
318        - Fixes bug #658 ASCII reader very broken
319
320
321    - New in Version 4.0 beta 1
322      --------------------
323      This beta adds support for the magnetic and multilevel models of 3.1.2
324      and along with a host of bug fixes found in the alpha.
325
326      - Model package changes and improvements
327         - All 3.1.2 models now available in new interface
328         - Old custom models should now still work
329            - '''NOTE:''' These will be deprecated in a future version. Old
330              custom models should be converted to the new model format which
331              is now the same as the built in models and offers much better
332              support.
333         - Custom model editor now creates new style models
334         - Custom model editor supports better error checking
335      - Documentation improvements
336        - Continued general cleanup
337      - Other improvements/additions
338         - Support for new canSAS 2D data files added
339         - Plot axes range can now be set manually as well as by zooming
340         - Plot annotations can now be moved around after being placed on plot.
341         - The active optimizer is now listed on the top of the fit panel.
342         - Linear fits now update qmin and max when the x scale limits are
343           changed.  Also the plot range no longer resets after a fit.
344      - Bug fixes
345         - Fixes bug #511 Errors in linearized fits and clean up of interface
346           including Kratky representation
347         - Fixes bug #186 Data operation Tool now executes when something is
348           entered in the text box and does not wait for the user to hit enter
349         - Fixes bug #459 plot context menu bug
350         - Fixes bug #559 copy to clipboard in graph menu broken
351         - Fixes bug #466 cannot remove a linear fit from graph
352         - Numerous bugs introduced in the alpha
353
354
355
356    - New in Version 4.0.0-alpha
357      --------------------
358      This alpha release brings a major overhaul of the model system. The new model
359      package allows rapid integration of custom models and access to polydispersity
360      without requiring a compiler.
361
362      - Model package changes and improvements
363         - Model interface moved to independent sasmodels package.
364         - Most models converted to new interface.
365         - Allows rapid integration of user-written models.
366         - OpenCL GPU utilization for faster fitting.
367         - Improved numerical integration of Bessel functions.
368      - SESANS integration and implementation
369         - Scripting interface added for analysis of SESANS data.
370         - Hankel transformation now accepts finite acceptance angles.
371         - 2D cosine transformation added for TOF SESANS analysis.
372      - Documentation improvements
373         - The documentation tree was restructured for a better end user experience.
374         - The documentation for each model was revamped and verified by at least
375           two people following the conversion of the model.
376         - Theoretical 1D (and 2D if applicable) scattering curves are auto-generated
377           and added to the model documentation for each model.
378      - Separation of GUI and calculations for future GUI enhancements
379      - Bug fixes
380         - Fixes bug #411 No stop button on simultaneous fit page
381         - Fixes bug #410 Error with raspberry model
382         - Fixes bug #364 Possible inconsistency in Poly_GausCoil model
383         - Fixes bug #439 Hayter Penfold MSA code needs checking
384         - Fixes bug #484 lammellerPC is precision limited
385         - Fixes bug #498 $HOME/.matplotlib conflicts
386         - Fixes bug #348 Control order in which fit parameters appear in the gui
387         - Fixes bug #456 Provide DREAM Results Panel with something to identify
388           data and age of results
389         - Fixes bug #556 Build script improvements for developers
390
391
392
393   - New in Version 3.1.2
394     --------------------
395     This release is a major stability improvement, having fixed a serious bug
396     that came to light since release 3.1.1. All users should upgrade.
397
398     - Fixes bug #468 broken remove constraint buttons in
399       simultaneous/constrained fitting panel
400     - Fixes bug #474 resulting from changes in 3.1.1 that had
401       introduced an error in the high-Q of slit-smeared models.
402     - Fixes bug #478 which would cause wx to run out of IDs and result
403       in SasView crashing even if left alone.
404     - Fixes bug #479 missing help button on simultaneous/constrained fit page
405     - Fixes bug #480 GUI resizing issues on simultaneous fit page
406     - Fixes bug #486 broken Report Results
407     - Fixes bug #488 redraw issues in fit page
408
409
410
411   - New in Version 3.1.1
412     --------------------
413     - Fixes bug #457 that prevented SasView from starting if the user was not
414       connected to the internet, or was behind a proxy server.
415
416   - New in Version 3.1.0
417     --------------------
418     - The documentation/help has had a complete overhaul including:
419       - A completely new presentation interface (Sphinx).
420       - Proof reading!
421       - Updating for latest features.
422       - A Help (or sometimes ?) button has been added to every panel, and some
423         sub panels if appropriate, linking to the appropriate section in the
424         documentation.
425       - The model help has been split so that the Details button now brings up
426         a very short pop-up giving the equation being used while HELP goes to
427         the section in the full documentation describing the model.
428       - Extensive help has also been added for the new optimizer engine (see
429         below) including rules of thumb on how and when to choose a given
430         optimizer and what the parameters do.
431     - The optimizer engine has been completely replaced. The new optimizer
432       still defaults to the standard Levenberg-Marquardt algorithm. However 4
433       other optimizers are now also available. Each starts with a set of default
434       parameters which can be tuned. The DREAM optimizer takes the longest but
435       is the most powerful and yields rich information including full parameter
436       correlation and uncertainty plots. A results panel has been added to
437       accommodate this.
438       - The five new optimizers are:
439         - A Levenberg-Marquardt optimizer
440         - A Quasi-Newton BFGS optimizer
441         - A Nelder-Mead Simplex optimizer
442         - A Differential Evolution optimizer
443         - A Monte Carlo optimizer (DREAM)
444     - New models were added:
445         - MicelleSphCoreModel (currently residing in the Uncategorized category)
446     - Existing models were updated:
447         - LamellarPS (bug in polydispersity integration fixed)
448         - RectangularPrismModel
449         - RectangularHollowPrismModel
450         - RectangularHollowPrismInfThinWallsModel
451     - Infrastructure to allow SESANS data to be fit with models was added. This
452       will become available in a future release but can currently be used from
453       the command line with some caveats.
454     - A number of bugs were fixed including a thread crashing issue and an
455       incorrect slit smearing resolution calculation.
456     - Implemented much more robust error logging to enable much easier
457       debugging in general but particularly the debugging of issues reported by
458       SasView users.
459     - A number of infrastructure tasks under the hood to enhance maintainability
460     - Upgrade from Wx 2.8 to Wx 3.0.2 which allows several new features but
461       required significant additional rework as well.
462     - Fully implemented Sphinx to the build process to produce both better
463       user documentation and developer documentation.
464     - Restructuring of the code base to more unified nomenclature and structure
465       so that the source installation tree more closely matches the installer
466       version tree.
467     - Code cleanup (an ongoing task) .
468     - Migration of the repository to github simplifying contributions from
469       non-project personnel through pull requests.
470
471   - New in Version 3.0.0
472     --------------------
473     - The GUI look and feel has been refactored to be more familiar for
474       Windows users by using MDI frames. Graph windows are also now free-
475       floating.
476     - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel,
477       RectangularPrismModel, RectangularHollowPrismModel and
478       RectangularHollowPrismInfThinWallsModel.
479     - The data loader now supports ILL DAT data files and reads the full meta
480       information from canSAS file formats.
481     - Redefined convention for specifying angular parameters for anisotropic
482       models.
483     - A number of minor features have been added such as permitting a log
484       distribution of points when using a model to simulate data, and the
485       addition of a Kratky plot option to the linear plots.
486     - A number of bugs have also been fixed.
487     - Save Project and Save Analysis now work more reliably.
488     - BETA: Magnetic contrast supporting full polarization analysis has been
489       implemented for some spherical and cylindrical models.
490     - BETA: Two new tools have been added:
491       - A generic scattering calculator which takes an atomic, magnetic or
492         SLD distribution in space and generates the appropriate 2D
493         scattering pattern. In some cases the orientationally averaged
494         (powder) 1D scattering can also be computed. Supported formats
495         include: SLD or text, PDB, and OMF magnetic moment distribution
496         file.
497       - An image viewer/converter for data in image format; this reads in
498         an image file and will attempt to convert the image pixels to
499         data. Supported formats include: TIFF, TIF, PNG, BMP, JPG.
500
501   - New in Version 2.2.1
502     --------------------
503     - Minor patch to support CanSAS XML v1.1 file format
504     - Added DataInfo for data in the DataExplorer and plots
505     - Added Maximize/Restore button in the title bar of the graphs
506     - Added a hide button in the toolbar of the graph panel
507     - The 'x' button now deletes a graph
508     - Edit SUM Model from the menubar can now generate and save more than one sum model
509     - Reports can now be saved in pdf format on WIN and MAC
510     - Made significant improvements to the batch/grid panel and fixed several bugs
511     - Fixed a number of other minor bugs
512
513   - New in Version 2.2.0
514     --------------------
515     - Application name changed to SasView
516     - New fully customizable Category Manager added for better management of
517       increasing number of models
518     - Improved the Grid Window functionality in the batch fitting mode
519     - Added a simpler Graph/Plot modification interface
520     - Added a new 'Data Operation' tool for addition, subtraction, multiplication,
521       division, of two data sets.
522     - The 'Sum Model' editor was extended and renamed 'Summation and Multiplication'
523       editor
524     - Added more plot symbols options for 1d plots
525     - Added improved trapping of compiling errors to the 'New model editor'
526     - Added some intelligent outputs (e.g., Rg, background, or rod diameter
527       depending on the choice of axis scale of the plot) to the linear fits
528     - Added more models
529
530   - Feature set from previous versions
531     -----------------------------------
532     - Perspectives Available
533       - Invariant calculator: Calculates the invariant, volume fraction, and
534         specific surface area.
535       - P(r) inversion calculator: Indirect Fourier transformation method.
536       - Fitting: the tool used for modeling and fitting 1D and 2D data to
537         analytical model functions
538       - Tools: provides a number of useful supplementary tools such as SLD
539         calculation
540
541     - Fitting
542       - Includes a large number of model functions, both form factors and structure factors.
543       - Support P(Q)*S(Q) for form factors that flag they can be so multiplied.
544       - Supports Gaussian, lognormal, Shulz, rectangular and custom distribution
545         functions for models that need to include polydispersity or for orientational
546         distributions if appropriate.
547       - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform
548         distribution of orientations of a given axis leading to modeling and fitting
549         capabilities of non azimuthaly symmetric data.
550       - User can choose to weight fits or not. If using weights, the user can choose
551         the error bar on each point if provided in the file, the square root
552         of the intensity or the intensity itself.
553       - Instrumental resolution smearing of model or fits is provided with several
554         options: read the resolution/point fromt he file. Input a pinhole resolution
555         or a slit resolution.
556       - Users can define the Qrange (Qmin and Qmax) for both 1D and 2D data for
557         fitting and modeling, but not graphically.  The range can be reset to the
558         defaults (limits of q in data set for a fit) with the reset button.
559       - A mask can be applied to 2D calculation and fitting.
560       - Normalized residual plots are provided with every fit.
561       - Model function help available through detail button or from the fitting panel.
562       - Simultaneous/(advanced)constrained fitting allows for fitting a single
563         data set or several different sets simultaneously with the application
564         of advanced constraints relating fit parameters to functions of other
565         parameters (including from a different set). For example thickness of
566         shell = sin(30) times the length.
567       - Models that are the sum of two other models can be easily generated through the
568         SUM Model menubar item.
569       - New Python models can be added on the fly by creating an appropriate Python
570         file in the model plugin directory. Two tools are provided to help:
571         An easy to use custom model editor allows the quick generation of new Python
572         models by supplying only the parameters and their default value (box 1)
573         and the mathematical function of the model (box 2) and generating the
574         necessary *.py file.  A separate advanced model editor provides a full Python
575         file editor.  Either way once saved the model becomes immediately available
576         to the application.
577       - A batch fitting capability allows for the analysis of a series of data sets to
578         a single model and provides the results in a tabular form suitable for saving
579         or plotting the evolution of the fit parameters with error bars (from within
580         the application).
581
582     - Tools
583       - A scattering length density calculator,including some X-ray information
584         is provided.
585       - A density to vol. fraction converter is provided
586       - In application access to a Python shell/editor (PyCrust) is provided
587       - An instrument resolution calculator, including possible gravitational and
588         TOF effects is provided
589       - A slit size calculator optimized for Anton Paar Saxess is provided.
590       - A kiessig fringe thickness calculator is provided
591
592     - Plots and plot management
593       - A 3D graphing option (for 2d data/results) is provided with the view
594         controlled by the mouse
595       - 2D plots are shown with an intensity color bar. 2D Color map can be user
596         adjusted.
597       - Supports output of plot to a variety of graphic formats. Supported formats
598         include: png, eps, emf, jpg/jpeg, pdf, ps, tif/tiff, rawRGBbitmap(raw, rgba),
599         and scalable vector graphic (svg/svgz)
600       - Supports ouput of data in plot (1 or 2D) to limited data formats
601       - Multiple data sets can be loaded into a single graph for viewing (but a fit
602         plot can currently only have a single plot).
603       - Extensive context sensitive plot/fitting/manipulation options are available
604         through a right mouse click pop-up menu on plots.
605
606     - Data management
607       - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data
608         via plug-in mechanism which can easily allow other readers as appropriate.
609       - 2D data is expected in Q space but for historical reasons accepts the
610         NIST 2D raw pixel format and will do conversion internally.
611       - The full data and metadata available to SasView is viewable in ASCII via
612         right clicking on a data set and choosing Data Info in the DataExplorer
613         or on the plots
614       - Supports loading a single file, multiple files, or a whole folder
615       - An optional Data Explorer is provided (default) which simplifies managing,
616         plotting, deleting, or setup for computation. Most functions however do
617         not require access to the explorer/manager and can be accessed through
618         right click menus and the toolbar.  The data explorer can be re-started
619         from the menu bar.
620
621     - Data manipulation
622       - Support various 2D averaging methods : Circular, sectors, annular,
623         boxsum, boxQx and boxQy.
624       - A 2D data maks editor is provided
625       - 2D mask can be applied to the circular averaging.
626
627     - Miscellaneous features
628       - limited reports can be generated in pdf format
629       - Provides multiprocessor support(Windows only)
630       - Limited startup customization currently includes default startup
631         data folder and choice of default starting with data manager
632       - Limited support for saving(opening) a SasView project or a SasView analysis
633         (subproject) is provided.
634       - SasView can be launched and loaded with a file of interesty by double-clicking
635         on that file (recognized extension)
636       - A data file or data folder can be passed to SasView when launched from
637         the command line.
638       - Limited bookmarking capability to later recall the results of a fit calculation
639         is provided.
640       - Extensive help is provided through context sensitive mouse roll-over,
641         information bar (at the bottom of the panel), the console menu, and
642         access to the help files in several different ways.
643
644
6452- Downloading and Installing
646=============================
647
648   *** Note 1:  The easiest approach to setting up the proper environment to
649                build from source is to use conda.  Instructions for setting up
650                using conda can be found at:
651                http://trac.sasview.org/wiki/DevNotes/CondaDevSetup
652   *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of
653                the following.  However it is highly recommended that any
654                previous versions be un-installed prior to installing the
655                new version.
656   *** Note 3:  Much more information is available at www.sasview.org under links.
657                Look in the 'For Developers' section and particularly the wiki at
658                www.sasview.org/trac/wiki.
659
660   2.1- System Requirements
661        - Python version >= 2.5 and < 3.0 should be running on the system
662        - We currently use Python 2.7
663
664   2.2- Installing from source
665        - Get the source code
666          - to follow the current development version from source control use
667              git clone https://github.com/SasView/sasview.git
668              git clone https://github.com/Sasview/sasmodels.git
669              git clone https://github.com/bumps/bumps.git
670
671        - Build, install and run a specific release
672          - make sure the requirements below are already installed
673          - retrieve the source from https://github.com/SasView/sasview/releases
674          - open a command line window in the 'sasview-x.x.x' directory
675          - run 'python setup.py install'
676          - run 'python sasview.py' under the 'sasview' folder.
677
678        - Build, install and run the current development version
679          - clone the source from git; also clone bumps, which is developed in parallel
680              git clone https://github.com/SasView/sasview.git
681              git clone https://github.com/Sasview/sasmodels.git
682              git clone https://github.com/bumps/bumps.git
683          - open a command line window in the 'sasview' directory
684          - run 'python setup.py build'
685          - run 'python run.py'; this runs from the source directories, so you
686            don't have to rebuild every time you make a change, unless you are
687            changing the C model files
688
689        - For the latest list of dependencies see the appropriate yml file in
690          the SasView repo at sasview/build_tools/conda/ymls
691
692
6933- Known Issues
694===============
695
696
697   4.2.0 - All systmes
698      There are currently no major known issues. A full list of known bugs and
699      feature requests by release version that users may wish to be aware of
700      can be viewed at http://trac.sasview.org/report/3
701      NOTE: Any corrections to models that may become known/available will be
702      posted to Marketplace as available (and fixed in the following release)
703
704   4.1- All systems:
705      The conversion to sasmodels infrastructure is ongoing and should be
706      completed in the next release. In the meantime this leads to a few known
707      issues:
708        - The way that orientation is defined is being refactored to address
709          long standing issues and comments.  In release 4.1 however only models
710          with symmetry (e.g. a=b) have been converted to the new definitions.
711          The rest (a <> b <> c - e.g. parellelepiped) maintain the same
712          definition as before and will be converted in 4.2.  Note that
713          orientational distribution also makes much more sense in the new
714          framework.  The documentation should indicate which definition is being
715          used for a given model.
716        - The infrastructure currently handles internal conversion of old style
717          models so that user created models in previous versions should continue
718          to work for now. At some point in the future such support will go away.
719          Everyone is encouraged to convert to the new structure which should be
720          relatively straight forward and provides a number of benefits.
721        - In that vein, the distributed models and those generated by the new
722          plugin model editor are in the new format, however those generated by
723          sum|multiply models are the old style sum|multiply models. This should
724          also disappear in the near future
725        - The on the fly discovery of plugin models and changes thereto behave
726          inconsistently.  If a change to a plugin model does not seem to
727          register, the Load Plugin Models (under fitting -> Plugin Model
728          Operations) can be used.  However, after calling Load Plugin Models, the
729          active plugin will no longer be loaded (even though the GUI looks like
730          it is) unless it is a sum|multiply model which works properly.  All
731          others will need to be recalled from the model dropdown menu to reload
732          the model into the calculation engine.  While it might be annoying it
733          does not appear to prevent SasView from working..
734        - The model code and documentation review is ongoing. At this time the
735          core shell parellelepiped is known to have the C shell effectively fixed
736          at 0 (noted in documentation) while the triaxial ellipsoid does not seem
737          to reproduce the limit of the oblate or prolate ellipsoid. If errors are
738          found and corrected, corrected versions will be uploaded to the
739          marketplace.
740
741   3.1- All systems:
742        - The documentation window may take a few seconds to load the first time
743          it is called. Also, an internet connection is required before
744          equations will render properly. Until then they will show in their
745          original TeX format.
746        - If the documentation window remains stubbornly blank, try installing a
747          different browser and set that as your default browser. Issues have
748          been noted with Internet Explorer 11.
749        - Check for Updates may fail (with the status bar message ' Cannot
750          connect to the application server') if your internet connection uses
751          a proxy server. Tested resolutions for this are described on the
752          website FAQ.
753        - The copy and paste functions (^C, ^V) in the batch mode results grid
754          require two clicks: one to select the cell and a second to select the
755          contents of the cell.
756        - The tutorial has not yet been updated and is somewhat out of date
757        - Very old computers may struggle to run the 3.x and later releases
758        - Polydispersity on multiple parameters included in a simultaneous/
759          constrained fit will likely not be correct
760        - Constrained/simultaneous fit page does not have a stop button
761        - Constrained/simultaneous fit do not accept min/max limits
762        - Save project does not store the state of all the windows
763        - Loading projects can be very slow
764        - Save Project only works once a data set has been associated with
765          a model.  Error is reported on status bar.
766        - There is a numerical precision problem with the multishell model when
767          the iner radius gets large enough (ticket #288)
768        - The angular distribution angles are not clearly defined and may in
769          some cases lead to incorrect calculations(ticket #332)
770
771   3.2- Windows:
772        - If installed to same directory as old version without first removing
773          the old version, the old desktop icon will remain but point to the
774          new exe version. Likewise all the start menu folders and items will
775          have the old name even though pointing to the new version.  Usually
776          safest to uninstall old version prior to installing new version anyway.
777
778   3.3- MAC:
779        - Application normally starts up hidden. Click icon in Dock to view/use
780          application.
781        - Multiprocessing does not currently work on MAC OS
782
783   3.4- Linux:
784        - Not well tested
785
786
7874- SasView website
788==================
789
790   - www.sasview.org.  This main project site is the gateway to all
791     information about the sasview project.  It includes information
792     about the project, a FAQ page and links to all developer and user
793     information, tools and resources.
794
795
7965- Frequently Asked Questions
797=============================
798
799   - www.sasview.org/faq.html
800
801
8026- Installer download website
803=============================
804
805   - Latest release Version
806     - https://github.com/SasView/sasview/releases
807   - Latest developer builds
808     - https://jenkins.esss.dk/sasview/view/Master-Builds/
Note: See TracBrowser for help on using the repository browser.