source: sasview/installers/README.txt @ 37b34a3

ESS_GUIESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalc
Last change on this file since 37b34a3 was 37b34a3, checked in by wojciech, 18 months ago

Added release notes and updated version numbers

  • Property mode set to 100644
File size: 33.4 KB
Line 
1Release Notes
2=============
3
41- Features
5===========
6    - New in Version 5.0.0
7      --------------------
8      - New, completely refactored GUI
9      - Fitting analysis interface simplified
10      - Constraints definition logic simplified and functionality extended
11      - Plugin model editor refactored and functionality extended
12      - Polydispersity plots added
13      - Improved stability and reliability
14      - Better user experience
15      - More logical workflows
16      - PyQt 5 based GUI
17      - Python3 compatibility
18
19    - New in Version 4.1.2
20      --------------------
21      This point release is a bug-fix release addressing:
22
23       - Fixes #984: PDF Reports Generate Empty PDFs
24       - Fixes a path typo
25       - 64 bit and 32 bit Windows executables now available
26
27      It is recommended that all users upgrade to this version
28
29    - New in Version 4.1.1
30      --------------------
31      This point release is a bug-fix release addressing:
32
33       - Fixes #948: Mathjax CDN is going away
34       - Fixes #938: Cannot read canSAS1D file output by SasView
35       - Fixes #960: Save project throws error if empty fit page
36       - Fixes #929: Problem deleting data in first fit page
37       - Fixes #918: Test folders not bundled with release
38       - Fixes an issue with the live discovery of plugin models
39       - Fixes an issue with the NXcanSAS data loader
40       - Updated tutorials for SasView 4.x.y
41
42    - New in Version 4.1.0
43      ------------------
44      This incremental release brings a series of new features and improvements,
45      and a host of bug fixes. Of particular note are:
46     
47      - Correlation Function Analysis (Corfunc)
48        This performs a correlation function analysis of one-dimensional SAXS/SANS data,
49        or generates a model-independent volume fraction profile from the SANS from an
50        adsorbed polymer/surfactant layer.
51
52        A correlation function may be interpreted in terms of an imaginary rod moving
53        through the structure of the material. Γ1D(R) is the probability that a rod of
54        length R moving through the material has equal electron/neutron scattering
55        length density at either end. Hence a frequently occurring spacing within a
56        structure manifests itself as a peak.
57
58        A volume fraction profile \Phi(z) describes how the density of polymer
59        segments/surfactant molecules varies with distance from an (assumed locally flat)
60        interface.
61
62      - Fitting of SESANS Data
63        Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will
64        be plotted against the correct axes and models will automatically perform a Hankel
65        transform in order to calculate SESANS from a SANS model.
66
67      - Documentation
68        The documentation has undergone significant checking and updating.
69
70      - Improvements
71        - Correlation function (corfunc) analysis of 1D SAS data added from CCP13
72        - File converter tool for multi-file single column data sets
73        - SESANS data loading and direct fitting using the Hankel transformation
74        - Saving and loading of simultaneous and constrained fits now supported
75        - Save states from SasView v3.x.y now loaded using sasmodel model names
76        - Saving and loading of projects with 2D fits now supported
77        - Loading a project removes all existing data, fits, and plots
78        - Structure factor and form factor can be plotted independently
79        - OpenCL is disabled by default and can be enabled through a fit menu
80        - Data and theory fields are now independently expandable
81      - Bug Fixes
82        - Fixes #667: Models computed multiple times on parameters changes
83        - Fixes #673: Custom models override built in models of same name
84        - Fixes #678: Hard crash when running complex models on GPU
85        - Fixes $774: Old style plugin models unloadable
86        - Fixes #789: stacked disk scale doesn't match cylinder model
87        - Fixes #792: core_shell_fractal uses wrong effective radius
88        - Fixes #800: Plot range reset on plot redraws
89        - Fixes #811 and #825: 2D smearing broken
90        - Fixes #815: Integer model parameter handling
91        - Fixes #824: Cannot apply sector averaging when no detector data present
92        - Fixes #830: Cansas HDF5 reader fully compliant with NXCanSAS v1.0 format
93        - Fixes #835: Fractal model breaks with negative Q values
94        - Fixes #843: Multilayer vesicle does not define effective radius
95        - Fixes #858: Hayter MSA S(Q) returns errors
96        - Numerous grammatical and contexual errors in documention
97
98
99    - New in Version 4.0.1
100      ------------------
101      This release fixes the critical bug #750 in P(Q)*S(Q).  Most damaging
102      it appears that the background term was being added to S(Q) prior to
103      multiplication by P(Q).
104
105
106    - New in Version 4.0
107      ------------------
108      This release fixes the various bugs found during the alpha and beta testing
109      - Improvements
110        - Support for reading data files from Anton Paar Saxess instruments
111        - Adds documentation on how to write custom models in the new framework
112      - Bug Fixes
113        - Fixes bug #604 Pringle model questions
114        - Fixes bug #472 Reparameterize Teubner-Strey
115        - Fixes bug #530 Numerical instabilities in Teubner Strey model
116        - Fixes bug #658 ASCII reader very broken
117
118
119    - New in Version 4.0 beta 1
120      --------------------
121      This beta adds support for the magnetic and multilevel models of 3.1.2
122      and along with a host of bug fixes found in the alpha.
123
124      - Model package changes and improvements
125         - All 3.1.2 models now available in new interface
126         - Old custom models should now still work
127            - '''NOTE:''' These will be deprecated in a future version. Old
128            custom models should be converted to the new model format which
129            is now the same as the built in models and offers much better
130            support.
131         - Custom model editor now creates new style models
132         - Custom model editor supports better error checking
133      - Documentation improvements
134        - Continued general cleanup
135      - Other improvements/additions
136         - Support for new canSAS 2D data files added
137         - Plot axes range can now be set manually as well as by zooming
138         - Plot annotations can now be moved around after being placed on plot.
139         - The active optimizer is now listed on the top of the fit panel.
140         - Linear fits now update qmin and max when the x scale limits are
141         changed.  Also the plot range no longer resets after a fit.
142      - Bug fixes
143         - Fixes bug #511 Errors in linearized fits and clean up of interface
144         including Kratky representation
145         - Fixes bug #186 Data operation Tool now executes when something is
146         entered in the text box and does not wait for the user to hit enter
147         - Fixes bug #459 plot context menu bug
148         - Fixes bug #559 copy to clipboard in graph menu broken
149         - Fixes bug #466 cannot remove a linear fit from graph
150         - Numerous bugs introduced in the alpha
151
152
153
154    - New in Version 4.0 beta 1
155      --------------------
156      This beta adds support for the magnetic and multilevel models of 3.1.2
157      and along with a host of bug fixes found in the alpha.
158
159      - Model package changes and improvements
160         - All 3.1.2 models now available in new interface
161         - Old custom models should now still work
162            - '''NOTE:''' These will be deprecated in a future version. Old
163            custom models should be converted to the new model format which
164            is now the same as the built in models and offers much better
165            support.
166         - Custom model editor now creates new style models
167         - Custom model editor supports better error checking
168      - Documentation improvements
169        - Continued general cleanup
170      - Other improvements/additions
171         - Support for new canSAS 2D data files added
172         - Plot axes range can now be set manually as well as by zooming
173         - Plot annotations can now be moved around after being placed on plot.
174         - The active optimizer is now listed on the top of the fit panel.
175         - Linear fits now update qmin and max when the x scale limits are
176         changed.  Also the plot range no longer resets after a fit.
177      - Bug fixes
178         - Fixes bug #511 Errors in linearized fits and clean up of interface
179         including Kratky representation
180         - Fixes bug #186 Data operation Tool now executes when something is
181         entered in the text box and does not wait for the user to hit enter
182         - Fixes bug #459 plot context menu bug
183         - Fixes bug #559 copy to clipboard in graph menu broken
184         - Fixes bug #466 cannot remove a linear fit from graph
185         - Numerous bugs introduced in the alpha
186
187
188
189    - New in Version 4.0.0-alpha
190      --------------------
191      This alpha release brings a major overhaul of the model system. The new model
192      package allows rapid integration of custom models and access to polydispersity
193      without requiring a compiler.
194
195      - Model package changes and improvements
196         - Model interface moved to independent sasmodels package.
197         - Most models converted to new interface.
198         - Allows rapid integration of user-written models.
199         - OpenCL GPU utilization for faster fitting.
200         - Improved numerical integration of Bessel functions.
201      - SESANS integration and implementation
202         - Scripting interface added for analysis of SESANS data.
203         - Hankel transformation now accepts finite acceptance angles.
204         - 2D cosine transformation added for TOF SESANS analysis.
205      - Documentation improvements
206         - The documentation tree was restructured for a better end user experience.
207         - The documentation for each model was revamped and verified by at least
208           two people following the conversion of the model.
209         - Theoretical 1D (and 2D if applicable) scattering curves are auto-generated
210           and added to the model documentation for each model.
211      - Separation of GUI and calculations for future GUI enhancements
212      - Bug fixes
213         - Fixes bug #411 No stop button on simultaneous fit page
214         - Fixes bug #410 Error with raspberry model
215         - Fixes bug #364 Possible inconsistency in Poly_GausCoil model
216         - Fixes bug #439 Hayter Penfold MSA code needs checking
217         - Fixes bug #484 lammellerPC is precision limited
218         - Fixes bug #498 $HOME/.matplotlib conflicts
219         - Fixes bug #348 Control order in which fit parameters appear in the gui
220         - Fixes bug #456 Provide DREAM Results Panel with something to identify
221           data and age of results
222         - Fixes bug #556 Build script improvements for developers
223
224
225
226   - New in Version 3.1.2
227     --------------------
228     This release is a major stability improvement, having fixed a serious bug
229     that came to light since release 3.1.1. All users should upgrade.
230
231     - Fixes bug #468 broken remove constraint buttons in
232       simultaneous/constrained fitting panel
233     - Fixes bug #474 resulting from changes in 3.1.1 that had
234       introduced an error in the high-Q of slit-smeared models.
235     - Fixes bug #478 which would cause wx to run out of IDs and result
236       in SasView crashing even if left alone.
237     - Fixes bug #479 missing help button on simultaneous/constrained fit page
238     - Fixes bug #480 GUI resizing issues on simultaneous fit page
239     - Fixes bug #486 broken Report Results
240     - Fixes bug #488 redraw issues in fit page
241
242
243
244   - New in Version 3.1.1
245     --------------------
246     - Fixes bug #457 that prevented SasView from starting if the user was not
247       connected to the internet, or was behind a proxy server.
248
249   - New in Version 3.1.0
250     --------------------
251     - The documentation/help has had a complete overhaul including:
252       - A completely new presentation interface (Sphinx).
253       - Proof reading!
254       - Updating for latest features.
255       - A Help (or sometimes ?) button has been added to every panel, and some
256         sub panels if appropriate, linking to the appropriate section in the
257         documentation.
258       - The model help has been split so that the Details button now brings up
259         a very short pop-up giving the equation being used while HELP goes to
260         the section in the full documentation describing the model.
261       - Extensive help has also been added for the new optimizer engine (see
262         below) including rules of thumb on how and when to choose a given
263         optimizer and what the parameters do.
264     - The optimizer engine has been completely replaced. The new optimizer
265       still defaults to the standard Levenberg-Marquardt algorithm. However 4
266       other optimizers are now also available. Each starts with a set of default
267       parameters which can be tuned. The DREAM optimizer takes the longest but
268       is the most powerful and yields rich information including full parameter
269       correlation and uncertainty plots. A results panel has been added to
270       accommodate this.
271       - The five new optimizers are:
272         - A Levenberg-Marquardt optimizer
273         - A Quasi-Newton BFGS optimizer
274         - A Nelder-Mead Simplex optimizer
275         - A Differential Evolution optimizer
276         - A Monte Carlo optimizer (DREAM)
277     - New models were added:
278         - MicelleSphCoreModel (currently residing in the Uncategorized category)
279     - Existing models were updated:
280         - LamellarPS (bug in polydispersity integration fixed)
281         - RectangularPrismModel
282         - RectangularHollowPrismModel
283         - RectangularHollowPrismInfThinWallsModel
284     - Infrastructure to allow SESANS data to be fit with models was added. This
285       will become available in a future release but can currently be used from
286       the command line with some caveats.
287     - A number of bugs were fixed including a thread crashing issue and an
288       incorrect slit smearing resolution calculation.
289     - Implemented much more robust error logging to enable much easier
290       debugging in general but particularly the debugging of issues reported by
291       SasView users.
292     - A number of infrastructure tasks under the hood to enhance maintainability
293     - Upgrade from Wx 2.8 to Wx 3.0.2 which allows several new features but
294       required significant additional rework as well.
295     - Fully implemented Sphinx to the build process to produce both better
296       user documentation and developer documentation.
297     - Restructuring of the code base to more unified nomenclature and structure
298       so that the source installation tree more closely matches the installer
299       version tree.
300     - Code cleanup (an ongoing task) .
301     - Migration of the repository to github simplifying contributions from
302       non-project personnel through pull requests.
303
304   - New in Version 3.0.0
305     --------------------
306     - The GUI look and feel has been refactored to be more familiar for
307       Windows users by using MDI frames. Graph windows are also now free-
308       floating.
309     - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel,
310       RectangularPrismModel, RectangularHollowPrismModel and
311       RectangularHollowPrismInfThinWallsModel.
312     - The data loader now supports ILL DAT data files and reads the full meta
313       information from canSAS file formats.
314     - Redefined convention for specifying angular parameters for anisotropic
315       models.
316     - A number of minor features have been added such as permitting a log
317       distribution of points when using a model to simulate data, and the
318       addition of a Kratky plot option to the linear plots.
319     - A number of bugs have also been fixed.
320     - Save Project and Save Analysis now work more reliably.
321     - BETA: Magnetic contrast supporting full polarization analysis has been
322       implemented for some spherical and cylindrical models.
323     - BETA: Two new tools have been added:
324       - A generic scattering calculator which takes an atomic, magnetic or
325         SLD distribution in space and generates the appropriate 2D
326         scattering pattern. In some cases the orientationally averaged
327         (powder) 1D scattering can also be computed. Supported formats
328         include: SLD or text, PDB, and OMF magnetic moment distribution
329         file.
330       - An image viewer/converter for data in image format; this reads in
331         an image file and will attempt to convert the image pixels to
332         data. Supported formats include: TIFF, TIF, PNG, BMP, JPG.
333
334   - New in Version 2.2.1
335     --------------------
336     - Minor patch to support CanSAS XML v1.1 file format
337     - Added DataInfo for data in the DataExplorer and plots
338     - Added Maximize/Restore button in the title bar of the graphs
339     - Added a hide button in the toolbar of the graph panel
340     - The 'x' button now deletes a graph
341     - Edit SUM Model from the menubar can now generate and save more than one sum model
342     - Reports can now be saved in pdf format on WIN and MAC
343     - Made significant improvements to the batch/grid panel and fixed several bugs
344     - Fixed a number of other minor bugs
345
346   - New in Version 2.2.0
347     --------------------
348     - Application name changed to SasView
349     - New fully customizable Category Manager added for better management of
350       increasing number of models
351     - Improved the Grid Window functionality in the batch fitting mode
352     - Added a simpler Graph/Plot modification interface
353     - Added a new 'Data Operation' tool for addition, subtraction, multiplication,
354       division, of two data sets.
355     - The 'Sum Model' editor was extended and renamed 'Summation and Multiplication'
356       editor
357     - Added more plot symbols options for 1d plots
358     - Added improved trapping of compiling errors to the 'New model editor'
359     - Added some intelligent outputs (e.g., Rg, background, or rod diameter
360       depending on the choice of axis scale of the plot) to the linear fits
361     - Added more models
362
363   - Feature set from previous versions
364     -----------------------------------
365     - Perspectives Available
366       - Invariant calculator: Calculates the invariant, volume fraction, and
367         specific surface area.
368       - P(r) inversion calculator: Indirect Fourier transformation method.
369       - Fitting: the tool used for modeling and fitting 1D and 2D data to
370         analytical model functions
371       - Tools: provides a number of useful supplementary tools such as SLD
372         calculation
373
374     - Fitting
375       - Includes a large number of model functions, both form factors and structure factors.
376       - Support P(Q)*S(Q) for form factors that flag they can be so multiplied.
377       - Supports Gaussian, lognormal, Shulz, rectangular and custom distribution
378         functions for models that need to include polydispersity or for orientational
379         distributions if appropriate.
380       - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform
381         distribution of orientations of a given axis leading to modeling and fitting
382         capabilities of non azimuthaly symmetric data.
383       - User can choose to weight fits or not. If using weights, the user can choose
384         the error bar on each point if provided in the file, the square root
385         of the intensity or the intensity itself.
386       - Instrumental resolution smearing of model or fits is provided with several
387         options: read the resolution/point fromt he file. Input a pinhole resolution
388         or a slit resolution.
389       - Users can define the Qrange (Qmin and Qmax) for both 1D and 2D data for
390         fitting and modeling, but not graphically.  The range can be reset to the
391         defaults (limits of q in data set for a fit) with the reset button.
392       - A mask can be applied to 2D calculation and fitting.
393       - Normalized residual plots are provided with every fit.
394       - Model function help available through detail button or from the fitting panel.
395       - Simultaneous/(advanced)constrained fitting allows for fitting a single
396         data set or several different sets simultaneously with the application
397         of advanced constraints relating fit parameters to functions of other
398         parameters (including from a different set). For example thickness of
399         shell = sin(30) times the length.
400       - Models that are the sum of two other models can be easily generated through the
401         SUM Model menubar item.
402       - New Python models can be added on the fly by creating an appropriate Python
403         file in the model plugin directory. Two tools are provided to help:
404         An easy to use custom model editor allows the quick generation of new Python
405         models by supplying only the parameters and their default value (box 1)
406         and the mathematical function of the model (box 2) and generating the
407         necessary *.py file.  A separate advanced model editor provides a full Python
408         file editor.  Either way once saved the model becomes immediately available
409         to the application.
410       - A batch fitting capability allows for the analysis of a series of data sets to
411         a single model and provides the results in a tabular form suitable for saving
412         or plotting the evolution of the fit parameters with error bars (from within
413         the application).
414
415     - Tools
416       - A scattering length density calculator,including some X-ray information
417         is provided.
418       - A density to vol. fraction converter is provided
419       - In application access to a Python shell/editor (PyCrust) is provided
420       - An instrument resolution calculator, including possible gravitational and
421         TOF effects is provided
422       - A slit size calculator optimized for Anton Paar Saxess is provided.
423       - A kiessig fringe thickness calculator is provided
424
425     - Plots and plot management
426       - A 3D graphing option (for 2d data/results) is provided with the view
427         controlled by the mouse
428       - 2D plots are shown with an intensity color bar. 2D Color map can be user
429         adjusted.
430       - Supports output of plot to a variety of graphic formats. Supported formats
431         include: png, eps, emf, jpg/jpeg, pdf, ps, tif/tiff, rawRGBbitmap(raw, rgba),
432         and scalable vector graphic (svg/svgz)
433       - Supports ouput of data in plot (1 or 2D) to limited data formats
434       - Multiple data sets can be loaded into a single graph for viewing (but a fit
435         plot can currently only have a single plot).
436       - Extensive context sensitive plot/fitting/manipulation options are available
437         through a right mouse click pop-up menu on plots.
438
439     - Data management
440       - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data
441         via plug-in mechanism which can easily allow other readers as appropriate.
442       - 2D data is expected in Q space but for historical reasons accepts the
443         NIST 2D raw pixel format and will do conversion internally.
444       - The full data and metadata available to SasView is viewable in ASCII via
445         right clicking on a data set and choosing Data Info in the DataExplorer
446         or on the plots
447       - Supports loading a single file, multiple files, or a whole folder
448       - An optional Data Explorer is provided (default) which simplifies managing,
449         plotting, deleting, or setup for computation. Most functions however do
450         not require access to the explorer/manager and can be accessed through
451         right click menus and the toolbar.  The data explorer can be re-started
452         from the menu bar.
453
454     - Data manipulation
455       - Support various 2D averaging methods : Circular, sectors, annular,
456         boxsum, boxQx and boxQy.
457       - A 2D data maks editor is provided
458       - 2D mask can be applied to the circular averaging.
459
460     - Miscellaneous features
461       - limited reports can be generated in pdf format
462       - Provides multiprocessor support(Windows only)
463       - Limited startup customization currently includes default startup
464         data folder and choice of default starting with data manager
465       - Limited support for saving(opening) a SasView project or a SasView analysis
466         (subproject) is provided.
467       - SasView can be launched and loaded with a file of interesty by double-clicking
468         on that file (recognized extension)
469       - A data file or data folder can be passed to SasView when launched from
470         the command line.
471       - Limited bookmarking capability to later recall the results of a fit calculation
472         is provided.
473       - Extensive help is provided through context sensitive mouse roll-over,
474         information bar (at the bottom of the panel), the console menu, and
475         access to the help files in several different ways.
476
477
4782- Downloading and Installing
479=============================
480
481   *** Note 1:  Much more information is available at www.sasview.org under links.
482                    Look in the 'For Developers' section and particularly the wiki at
483                www.sasview.org/trac/wiki.
484   *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of
485                the following.  However it is highly recommended that any
486                previous versions be un-installed prior to installing the
487                new version.
488
489   2.1- System Requirements
490        - Python version >= 2.5 and < 3.0 should be running on the system
491        - We currently use Python 2.7
492
493   2.2- Installing from source
494        - Get the source code
495          - to follow the current development version from source control use
496              git clone https://github.com/SasView/sasview.git
497              git clone https://github.com/bumps/bumps.git
498          - to install a specific version
499
500        - Build, install and run a specific release
501          - make sure the requirements below are already installed
502          - retrieve the source from https://github.com/SasView/sasview/releases
503          - open a command line window in the 'sasview-x.x.x' directory
504          - run 'python setup.py install'
505          - run 'python sasview.py' under the 'sasview' folder.
506
507        - Build, install and run the current development version
508          - clone the source from git; also clone bumps, which is developed in parallel
509              git clone https://github.com/SasView/sasview.git
510              git clone https://github.com/bumps/bumps.git
511          - open a command line window in the 'sasview' directory
512          - run 'python setup.py build'
513          - run 'python run.py'; this runs from the source directories, so you
514            don't have to rebuild every time you make a change, unless you are
515            changing the C++ model files
516
517        - The following modules are required (version numbers are what are used
518          in the windows release build):
519
520          - Common Packages
521            - reportlab 3.1.44
522            - lxml 3.4.4.0 (MAC 3.4.2.0)
523            - PIL 1.1.7
524            - xhtml2pdf 3.0.33 (MAC = not installed on build server)
525            - unittest-xml-reporting 1.12.0 (MAC 1.10.0)
526            - matplotlib Version Installed: 1.4.3 (MAC 1.1.1)
527            - bumps Version Installed: 0.7.5.9
528            - scipy Version Installed: 0.16.0b2 (MAC 0.11.0)
529            - periodictable Version Installed: 1.4.1
530            - setuptools Version Installed: 7.0 (MAC 12.0.5)
531            - sphinx Version Installed: 1.3.1 (MAC 1.3b2)
532            - pyparsing Version Installed: 2.0.3
533            - numpy Version Installed: 1.9.2 (MAC 1.6.2)
534            - html5lib Version Installed: 0.99999
535            - wx Version Installed: 3.0.2.0
536
537          - Windows Specific Packages
538            - pywin 219
539            - py2exe 0.6.9
540            - comtypes 1.1.1
541            - MinGW w/ gcc version 4.6.1 (WIN)
542            - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008
543              re-distributable)
544            - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable
545
546            *** Note: Windows build dependencies can be set up using anaconda. Instructions
547                can be found at http://trac.sasview.org/wiki/AnacondaSetup
548
549          - MAC Specifc Packages
550            - py2app 0.7.1
551
552
5533- Known Issues
554===============
555
556
557   4.1- All systems:
558      The conversion to sasmodels infrastructure is ongoing and should be
559      completed in the next release. In the meantime this leads to a few known
560      issues:
561        - The way that orientation is defined is being refactored to address
562        long standing issues and comments.  In release 4.1 however only models
563        with symmetry (e.g. a=b) have been converted to the new definitions.
564        The rest (a <> b <> c - e.g. parellelepiped) maintain the same
565        definition as before and will be converted in 4.2.  Note that
566        orientational distribution also makes much more sense in the new
567        framework.  The documentation should indicate which definition is being
568        used for a given model.
569        - The infrastructure currently handles internal conversion of old style
570        models so that user created models in previous versions should continue
571        to work for now. At some point in the future such support will go away.
572        Everyone is encouraged to convert to the new structure which should be
573        relatively straight forward and provides a number of benefits.
574        - In that vein, the distributed models and those generated by the new
575        plugin model editor are in the new format, however those generated by
576        sum|multiply models are the old style sum|multiply models. This should
577        also disappear in the near future
578        - The on the fly discovery of plugin models and changes thereto behave
579        inconsistently.  If a change to a plugin model does not seem to
580        register, the Load Plugin Models (under fitting -> Plugin Model
581        Operations) can be used.  However, after calling Load Plugin Models, the
582        active plugin will no longer be loaded (even though the GUI looks like
583        it is) unless it is a sum|multiply model which works properly.  All
584        others will need to be recalled from the model dropdown menu to reload
585        the model into the calculation engine.  While it might be annoying it
586        does not appear to prevent SasView from working..
587        - The model code and documentation review is ongoing. At this time the
588        core shell parellelepiped is known to have the C shell effectively fixed
589        at 0 (noted in documentation) while the triaxial ellipsoid does not seem
590        to reproduce the limit of the oblate or prolate ellipsoid. If errors are
591        found and corrected, corrected versions will be uploaded to the
592        marketplace.
593   
594   3.1- All systems:
595        - The documentation window may take a few seconds to load the first time
596          it is called. Also, an internet connection is required before
597          equations will render properly. Until then they will show in their
598          original TeX format.
599        - If the documentation window remains stubbornly blank, try installing a
600          different browser and set that as your default browser. Issues have
601          been noted with Internet Explorer 11.
602        - Check for Updates may fail (with the status bar message ' Cannot
603          connect to the application server') if your internet connection uses
604          a proxy server. Tested resolutions for this are described on the
605          website FAQ.
606        - The copy and paste functions (^C, ^V) in the batch mode results grid
607          require two clicks: one to select the cell and a second to select the
608          contents of the cell.
609        - The tutorial has not yet been updated and is somewhat out of date
610        - Very old computers may struggle to run the 3.x and later releases
611        - Polydispersity on multiple parameters included in a simultaneous/
612          constrained fit will likely not be correct
613        - Constrained/simultaneous fit page does not have a stop button
614        - Constrained/simultaneous fit do not accept min/max limits
615        - Save project does not store the state of all the windows
616        - Loading projects can be very slow
617        - Save Project only works once a data set has been associated with
618          a model.  Error is reported on status bar.
619        - There is a numerical precision problem with the multishell model when
620          the iner radius gets large enough (ticket #288)
621        - The angular distribution angles are not clearly defined and may in
622          some cases lead to incorrect calculations(ticket #332)
623
624   3.2- Windows:
625        - If installed to same directory as old version without first removing
626          the old version, the old desktop icon will remain but point to the
627          new exe version. Likewise all the start menu folders and items will
628          have the old name even though pointing to the new version.  Usually
629          safest to uninstall old version prior to installing new version anyway.
630
631   3.3- MAC:
632        - Application normally starts up hidden. Click icon in Dock to view/use
633          application.
634        - Multiprocessing does not currently work on MAC OS
635
636   3.4- Linux:
637        - Not well tested
638
639
6404- SasView website
641==================
642
643   - www.sasview.org.  This main project site is the gateway to all
644     information about the sasview project.  It includes information
645     about the project, a FAQ page and links to all developer and user
646     information, tools and resources.
647
648
6495- Frequently Asked Questions
650=============================
651
652   - www.sasview.org/faq.html
653
654
6556- Installer download website
656=============================
657
658   - Latest release Version
659     - https://github.com/SasView/sasview/releases
660   - Latest developer builds
661     - https://jenkins.esss.dk/sasview/view/Master-Builds/
Note: See TracBrowser for help on using the repository browser.