source: sasview/installers/README.txt @ 7aab144

config-errorpy37-allpy37-sascalcpy37-sasguipytestsetup_clean_upsimplify-c-buildticket-1094-headlessticket-1111ticket-1205-fit-weightsticket-1218ticket-1220unittest-saveload
Last change on this file since 7aab144 was 7aab144, checked in by butler, 3 months ago

Update 4.2.0 release notes

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