source: sasview/installers/README.txt @ 16030b1

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

copy King's updates to README-next-release to README.txt

README.txt are the release notes. We should probably get rid of the
README-next-release. Once a release is made we can start adding notes
to README.txt for the next release I would think?

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