source: sasview/installers/README.txt @ f4a1433

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalc
Last change on this file since f4a1433 was f4a1433, checked in by Piotr Rozyczko <rozyczko@…>, 7 years ago

Merge branch 'master' into ESS_GUI

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