-                      r2b07b6d
+                      r7aab144
 Release Notes
 =============
+    This is a beta pre-release version of 4.2.0.  A number of fixes and changes
+    have been made in the year since the previous release.
+    Full release notes will be compiled prior to the full release 4.2.0.
+- Features
+===========
+    - New in Version 4.2.0
+      --------------------
+      This release heralds many improvements and a host of bug fixes, along with
+      some significant changes from previous versions. Further, as promised, it
+      marks the end of support for 32 bit operating systems and is only
+      available for 64bit operating systems. With this version the change to the
+      new model API and plugins infrastructure begun with 4.0 is essentially
+      complete (though extensions are in the works and more are likely they
+      should remain backwardly compatible with previous versions of SasView).
+      NOTE: old style plugin models, including old sum|mul mocels will continue
+      to be supported (i.e. SasView will be able to run them) in 4.x. However,
+      the expectation is that such support will be removed in 5.0 and everyone
+      is strongly encouraged to convert their custom models to the new API.
+      Finally, the new orientation angles and orientatinal distribution is now
+      also complete.
+      - Changes
+         - The infrastucture for calculating 2D patterns from 3D orientated objects
+           has been totally re-factored. It is now more accurate and consistent
+           across models.
+         - The way that SasView defines the orientation of anisometric and
+           aligned objects has been completely overhauled. It now differs from
+           previous versions.
+         - Plugin models, including sum/multiply models, have completely migrated
+           to the new infrastructure. NOTE that 3.x type models as well as early,
+           intermediate 4.x type models, including those generated by sum|multiply
+           will continue to be supported in 4.x but will likely no longer be
+           supported after the move to 5.0.  Users are strongly encouraged to
+           migrate any custom models.
+         - The NeXus loader has been removed as it is superseded by the NXcanSAS
+           standard loader and SasView does not support the treatment of raw
+           data.
+      - Improvements
+         - The accuracy/speed of some numerical integrations have been improved.
+         - An orientation viewer tool has been introduced to assist in
+           understanding the new orientation framework.
+         - Problems with the computation of magnetic scattering from some
+           objects have been rectified. Some questions however remain.
+         - The known issue with the core_shell_parallelepiped model is now fixed.
+         - A number of issues and inconsistencies with the creation of
+           sum|product models have been rectified.
+         - A Boltzmann distribution has been added for polydispersity/orientational
+           distributions.
+         - Some batch slicing options have been introduced.
+         - Correlation function analysis now computes both the 1D and 3D functions.
+         - There are several data loading improvements.
+         - There are several improvements to Save/Load Project.
+         - There have been numerous other bug fixes.
+      - Documentation
+         Several sections of the help documentation have undergone significant
+           checking and updating, particularly those relating to orientation,
+           magnetic scattering, and polydispersity distributions. Detailed
+           advanced instructions for plugin writing and some scripting
+           instructions have been added.
+      - Other work
+         - A Third-Party initiative has recently succeeded in getting SasView to
+           run on Debian. More details at
+           http://trac.sasview.org/wiki/DevNotes/Projects/Debian
+         - With this release we have started to prepare for the inevitable move
+           to Python 3, which will occur with the release of 5.0
+         - SasView 5.0 is currently in development. The two most significant
+           features of this version will be (i) a move away from the present
+           WxPython GUIs to new, completely rewritten, Qt5 GUIs, and
+           (ii)implementation of the Beta-approximation for S(Q). Subject to
+           resources, some limited access to the latter functionality may be
+           available in a future SasView 4.x release.
+      - Bug Fixes
+         Fixes # 260: Box integration does not update when entering values in dialog
+         Fixes # 446: Saving plot as PGF (not PDF!) format throws error
+         Fixes # 467: Extend batch functionality to slicer
+         Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly
+           (USANS slit smearing)
+         Fixes # 499: create sin(x)/x, 2*J1(x)/x and 3*j1(x)/x functions
+         Fixes # 510: Build PDF documentation along with HTML
+         Fixes # 525: Add GUI category defaults to models in sasmodels
+         Fixes # 579: clean up sasview directory
+         Fixes # 597: Need to document Combine Batch Fit
+         Fixes # 645: GUI logic problem in Batch vs single fit mode
+         Fixes # 648: Need to allow user input background value in Pr perspective
+         Fixes # 685: Fix data upload to marketplace
+         Fixes # 695: linear slope in onion model
+         Fixes # 735: Review new Corfunc documentation
+         Fixes # 741: Recalculate P(Q) and S(Q) components on model update.
+         Fixes # 767: Sum/Product Models don't do what they should
+         Fixes # 776: angular dispersity
+         Fixes # 784: Add 3D integral to Correlation Function analysis
+         Fixes # 786: core_shell_parallelepiped 1-D model is incorrect
+         Fixes # 818: report button followed by save makes an empty pdf file
+         Fixes # 838: Fix model download from marketplace
+         Fixes # 848: can't save analysis when only one fit page
+         Fixes # 849: Load Folder should ignore files starting with .
+         Fixes # 852: More unit tests, especially for oriented or 2d models
+         Fixes # 854: remove unnecessary sleep() in fitting perspective
+         Fixes # 856: Reading SAS_OPENCL from custom_config sometimes raises an ERROR
+         Fixes # 861: cannot defined a structure factor plugin
+         Fixes # 864: New Model Editor (simple plugin editor) error parsing
+           parameter line
+         Fixes # 865: Plugin live discovery issues
+         Fixes # 866: inform user when NaN is returned from compute
+         Fixes # 869: fit page computation thread cleanup
+         Fixes # 875: Possible weirdness with 1D NXcanSAS data
+         Fixes # 876: Add check for HDF5 format in dataloader
+         Fixes # 887: reorganize tree, separating the installed source from the
+           build source
+         Fixes # 889: Refactor dataloader error handling infrastructure
+         Fixes # 890: use new orientation definition for asymmetric shapes
+         Fixes # 891: update docs for oriented shapes with new orientation definition
+         Fixes # 896: equations in core shell parallelepiped docs do not match code
+         Fixes # 898: Image Viewer Tool file selector issue
+         Fixes # 899: Igor Reader q calculation
+         Fixes # 902: IgorReader Q calculation needs fixing/improving
+         Fixes # 903: sasview - all non-gui tests should be converted to run in Python 3
+         Fixes # 906: polydispersity not showing up in tabulated results
+         Fixes # 912: About box points to misleading contributors page on Github
+         Fixes # 915: load project issues
+         Fixes # 916: Proper Logging
+         Fixes # 920: Logarithmic binning option in the slice viewer
+         Fixes # 921: Improve developer communication methods
+         Fixes # 922: Remove support for all data formats that are not in q space
+         Fixes # 923: Add CI and trac integrations to Slack
+         Fixes # 930: fitting help says chisq is normalized to number of points
+         Fixes # 931: Allow admins to edit all models and upload data etc on
+           marketplace
+         Fixes # 932: Need to fix upload of data files to marketplace
+         Fixes # 934: Slurp tutorial repo for tutorials
+         Fixes # 935: Build new tutorials as PDF
+         Fixes # 943: Deep copy error on setting model after data is selected
+         Fixes # 950: Most of the readers don't close files properly.
+         Fixes # 954: cross check dll/opencl/python polydispersity and
+           orientation results
+         Fixes # 956: Possible problem with new doc build process
+         Fixes # 961: sasmodels tests should fail if the parameter name does not exist
+         Fixes # 962: star polymer typo in docs
+         Fixes # 967: no uncertainties errors on fitting parameters
+         Fixes # 969: About Box not picking up dls_logo.png
+         Fixes # 970: ASCII loader doesn't handle ISIS 2D ASCII
+         Fixes # 974: blacklist Intel HD 620/630 for double precision
+         Fixes # 978: load project fails for pages which have not been defined
+         Fixes # 983: Remove Nexus Loader
+         Fixes # 984: PDF reports are not being properly generated on Windows
+         Fixes # 985: Saving Project Fails
+         Fixes # 986: Send to fitting overwrites theory page even if blank
+           FitPage has focus
+         Fixes # 990: utest_sasview.py giving different results than run_one.py
+         Fixes # 993: Windows x64 versions not installing to correct folder
+         Fixes # 994: Error changing fit engine
+         Fixes # 995: OpenCL required on Linux even if turned off in GUI
+         Fixes #1006: multiplicity models don't work with SQ
+         Fixes #1007: spherical_sld model freezes SasView
+         Fixes #1008: plugin model scaling not working? S
+         Fixes #1010: Win64 build script not creating working executable
+         Fixes #1011: sld_test failing on ubuntu
+         Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded
+           multiple times
+         Fixes #1018: add Boltzmann distribution
+         Fixes #1021: add PDF documentation to website and document in wiki
+           release process
+         Fixes #1024: Update version numbers in master
+         Fixes #1025: Sum/multiply editor hangs
+         Fixes #1032: convert C++ modules to C
+         Fixes #1035: Order of combining P(Q) and S(Q) in Plugins seems to matter
+         Fixes #1037: data loader crop not working? & all fits crashing
+         Fixes #1043: problem compiling marketplace models
+         Fixes #1050: fix appveyor test for sasmodels win 64 python 3
+         Fixes #1052: Can't use a user-created plugin model in a plugin model
+         Fixes #1057: phi rotation issue for elliptical cylinder
+         Fixes #1060: incorrect default for rectangle dispersion
+         Fixes #1062: win32 build not installing correctly
+         Fixes #1064: Fitting did not converge!!! error with a Sum|Multi plugin model
+         Fixes #1069: GUI problem when using polydispersity/orientation distributions
+         Fixes #1070: Parameter error boxes should not be editable
+         Fixes #1079: Remove save button in report dialog on Mac
+         Fixes #1081: GUI problem with new orientation distribution
+         Fixes #1083: Magnetic models not being computed
+         Fixes #1099: Erratic behaviour of Sum|Multi model in 4.1.2
+         Fixes #1101: Batch results page not displaying polydispersity values
+         Fixes #1131: OpencCl dialog does not open
+         Fixes #1132: Slit Size Calculator Tool not working
+         Fixes #1139: Missing Docs and Help for new Batch Slicing
+         Fixes #1141: Intro to scripting.rst needs improvement
+         Fixes #1142: Plugin framework is broken
+         Fixes #1044: Unable to upload c file to marketplace
+         Fixes #1145: Update models in model marketplace to 4.2 when 4.2 is released.
+         Fixes #1148: Documentation for S(Q) models need updating
+         Fixes #1128: AutoPlot generation for model documentation does not
+           include background
+      It is recommended that all users upgrade to this version, but your
+      attention is drawn to the Changes section above.
+    - New in Version 4.2.0-Beta
+      -------------------------
+      This is a beta pre-release version of 4.2.0.  A number of fixes and changes
+      have been made in the year since the previous release. Full release notes
+      will be compiled prior to the full release 4.2.0.
     Highlights are:
+      Highlights are:
         - Infrastucture for calculating 2D patterns from 3D orientated objects
           has now been totally refactored
         - Plugins have completely migrated to the new infrastructure now,
           including sum/multiply models
+              including sum/multiply models
         - Some batch slicing options have been introduced
         - The known issue with the core_shell_parallelepiped is now fixed
 …
         - Lots of documentation enhancement
+    In the meantime please report any bugs or issues found while using this beta
+- Features
+===========
+      In the meantime please report any bugs or issues found while using this beta
     - New in Version 4.1.2
       --------------------
 …
 =============================
+   *** Note 1:  Much more information is available at www.sasview.org under links.
+                    Look in the 'For Developers' section and particularly the wiki at
+                www.sasview.org/trac/wiki.
+   *** Note 1:  The easiest approach to setting up the propoer environment to
+                build from source is to use conda.  Instructions for setting up
+                using conda can be found at:
+                http://trac.sasview.org/wiki/DevNotes/CondaDevSetup
    *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of
                 the following.  However it is highly recommended that any
                 previous versions be un-installed prior to installing the
                 new version.
+   *** Note 3:  Much more information is available at www.sasview.org under links.
+                    Look in the 'For Developers' section and particularly the wiki at
+                www.sasview.org/trac/wiki.
 .1- System Requirements
 …
           - to follow the current development version from source control use
               git clone https://github.com/SasView/sasview.git
+              git clone https://github.com/Sasview/sasmodels.git
               git clone https://github.com/bumps/bumps.git
           - to install a specific version
 …
           - clone the source from git; also clone bumps, which is developed in parallel
               git clone https://github.com/SasView/sasview.git
+              git clone https://github.com/Sasview/sasmodels.git
               git clone https://github.com/bumps/bumps.git
           - open a command line window in the 'sasview' directory
 …
           - run 'python run.py'; this runs from the source directories, so you
             don't have to rebuild every time you make a change, unless you are
+            changing the C++ model files
+        - The following modules are required (version numbers are what are used
+          in the windows release build):
+          - Common Packages
+            - reportlab 3.1.44
+            - lxml 3.4.4.0 (MAC 3.4.2.0)
+            - PIL 1.1.7
+            - xhtml2pdf 3.0.33 (MAC = not installed on build server)
+            - unittest-xml-reporting 1.12.0 (MAC 1.10.0)
+            - matplotlib Version Installed: 1.4.3 (MAC 1.1.1)
+            - bumps Version Installed: 0.7.5.9
+            - scipy Version Installed: 0.16.0b2 (MAC 0.11.0)
+            - periodictable Version Installed: 1.4.1
+            - setuptools Version Installed: 7.0 (MAC 12.0.5)
+            - sphinx Version Installed: 1.3.1 (MAC 1.3b2)
+            - pyparsing Version Installed: 2.0.3
+            - numpy Version Installed: 1.9.2 (MAC 1.6.2)
+            - html5lib Version Installed: 0.99999
+            - wx Version Installed: 3.0.2.0
+          - Windows Specific Packages
+            - pywin 219
+            - py2exe 0.6.9
+            - comtypes 1.1.1
+            - MinGW w/ gcc version 4.6.1 (WIN)
+            - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008
+              re-distributable)
+            - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable
+            *** Note: Windows build dependencies can be set up using anaconda. Instructions
+                can be found at http://trac.sasview.org/wiki/AnacondaSetup
+          - MAC Specifc Packages
+            - py2app 0.7.1
+            changing the C model files
+        -For the latest list of dependencies see the appropriate yml file in
+          the SasView repo at sasview/build_tools/conda/ymls
 …
 ===============
+.2.0 - All systmes
+      There are currently no major known issues. A full list of known bugs and
+      feature requests by release version that users may wish to be aware of
+      can be viewed at http://trac.sasview.org/report/3
+      NOTE: Any corrections to models that may become known/available will be
+      posted to Marketplace as available (and fixed in the following release)
 .1- All systems:

Note: See TracChangeset for help on using the changeset viewer.

SasView

Changeset 7aab144 in sasview for installers/README.txt

Legend:

installers/README.txt

Download in other formats: