Release 5.0.4

LICENSE.TXT

@@ -1,4 +1,5 @@
-Copyright (c) 2009-2020, SasView Developers
+Copyright (c) 2009-2021, SasView Developers
+
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

build_tools/conda_qt5_win_commercial.yml

@@ -33,5 +33,4 @@ dependencies:
    - ../../../PyQt5_commercial-5.12.2-5.12.3-cp35.cp36.cp37.cp38-none-win_amd64.whl
    - qt5reactor==0.5
    - tinycc==1.1
-   - pillow==8.1.2
-
+   - pillow==8.1.2

build_tools/release_automation.py

@@ -31,7 +31,7 @@
         {'name': 'McKerns, Mike', 'affiliation': 'California Institute of Technology', 'type':'Researcher'},
         {'name': 'Mothander, Karolina', 'affiliation': 'Lund University', 'type':'Researcher'},
         {'name': 'Narayanan, Theyencheri', 'affiliation': 'European Synchrotron Radiation Facility', 'type':'Researcher'},
-        {'name': 'Parsons, Drew', 'affiliation': 'University of New South Wales', 'type':'DataManager'},
+        {'name': 'Parsons, Drew', 'affiliation': 'University of Cagliari and the Debian Project', 'type':'DataManager'},
         {'name': 'Porcar, Lionel', 'affiliation': 'Institut Laue-Langevin', 'type':'Researcher'},
         {'name': 'Pozzo, Lilo', 'affiliation': 'University of Washington', 'type':'Researcher'},
         {'name': 'Rakitin, Maksim', 'affiliation': 'Brookhaven National Laboratory','type':'DataManager'},
@@ -65,7 +65,7 @@
         {'name': 'Nielsen, Torben','affiliation': 'Data Management and Software Centre, European Spallation Source'},
         {'name': "O'Driscoll, Lewis",'affiliation': 'STFC - Rutherford Appleton Laboratory'},
         {'name': 'Potrzebowski, Wojciech','affiliation': 'Data Management and Software Centre, European Spallation Source ERIC', 'orcid': '0000-0002-7789-6779'},
-        {'name': "Prescott, Stewart",'affiliation': 'University of New South Wales'},
+        {'name': "Prescott, Stuart",'affiliation': 'University of New South Wales and the Debian Project', 'orcid': '0000-0001-5639-9688'},
         {'name': 'Ferraz Leal, Ricardo','affiliation': 'Oak Ridge National Laboratory'},
         {'name': 'Rozyczko, Piotr','affiliation': 'Data Management and Software Centre, European Spallation Source ERIC', 'orcid' : '0000-0002-2359-1013' },
         {'name': 'Snow, Tim','affiliation': 'Diamond Light Source','orcid': '0000-0001-7146-6885'},

docs/sphinx-docs/source/conf.py

@@ -70,7 +70,7 @@
 
 # General information about the project.
 project = u'SasView'
-copyright = u'2019, The SasView Project'
+copyright = u'2021, The SasView Project'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -79,7 +79,7 @@
 # The short X.Y version.
 version = '5.0'
 # The full version, including alpha/beta/rc tags.
-release = '5.0.3'
+release = '5.0.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/sphinx-docs/source/user/RELEASE.rst

@@ -11,6 +11,162 @@ Release Notes
 Features
 ========
 
+New in Version 5.0.4
+--------------------
+This is a point release which fixes some issues reported in earlier versions
+of 5.0.x:
+
+* A bug that had been around since 4.2.2 and which prevented Batch Fitting from
+  using any dI values in the data file has finally been fixed. The consequence of
+  this bug was that Single Fits and Batch Fits on the same datasets could return
+  different parameters. Now, where present, dI values will always be used by default
+  in both cases.
+* The bug introduced in 5.0.3 which prevented the plotting of Batch Fit results has also
+  been fixed.
+* An issue with the behaviour of the 1D pinhole resolution smearing routine in cases of
+  large divergence has been addressed.
+* A number of improvements have been made to plotting and plot management.
+* Several usability issues in the P(r) Inversion and Invariant Analysis perspectives
+  have been addressed.
+* Improvements have also been made to the functioning of Project Save/Load.
+
+There are also some new features in this version:
+
+* Though not strictly a new feature, the functionality and operation of parameter
+  constraints has been significantly overhauled for this version.
+* The slicer functionality has been significantly overhauled and made to work properly.
+* The slider bars on plots for selecting the q-range for fitting that featured in earlier
+  versions of SasView have been re-introduced by popular request, although they do not
+  yet work on linearized plots.
+* It is now possible to swap the dataset used to create an existing FitPage for a different
+  dataset. This removes the need to re-generate a complex model (eg, featuring many parameters
+  and/or constraints) many times over to use it to fit several datasets.
+* It is now also possible to assign custom names to loaded datasets, rather than just
+  identifying the data by its filename. Right-click on a dataset in the Data Explorer
+  to activate.
+
+New features/improvements
+^^^^^^^^^^^^^^^^^^^^^^^^^
+* sasview #1725: Horizontal line at y=0 needed in P(r) plots
+* sasview #1702: Allow for a choice of how data is named in the Data Explorer
+* sasview #1699: Allow check/uncheck of sub-selected data in Data Explorer
+* sasview #1676: Checkbox of highlighted row is checked also when clicking another checkbox
+* sasview #1303: CanSAS XML Reader refactor
+
+* sasmodels #443: Update to polydispersity.rst
+* sasmodels #429: Create model for superparamagnetic relaxing particles
+* sasmodels #390: Re-describe Source intensity in model parameter tables
+* sasmodels #253: use new orientation for magnetic models (Trac #910)
+
+
+Bug fixes
+^^^^^^^^^
+* Fixes sasview #1796: Batch Fitting does not respect Q-range for fitting 
+* Fixes sasview #1795: Display of batch fitting results is broken in 5.0.4
+* Fixes sasview #1794: Batch fitting in 5.x returns different parameters to single fits in 5.x
+* Fixes sasview #1782: RgQmax and RgQmin are inverted in the Gunier linear fit
+* Fixes sasview #1776: Slicers Using Masked Data Points in Calculation
+* Fixes sasview #1754: Delete Data does not remove data or plots from Fitting, P(r) or Inversion
+* Fixes sasview #1738: Conflicting definition of displayData()
+* Fixes sasview #1711: sasview 5, Q resolution smearing issues with broad_peak model
+* Fixes sasview #1710: sasview fails to open .h5 files using h5py 3.1
+* Fixes sasview #1701: Issue with slashes in data titles in CanSAS1D (and probably NXcanSAS)
+* Fixes sasview #1698: Provide P(Q) separately when fitting
+* Fixes sasview #1696: Failure in getSymbolDict on selecting parameters for constraints
+* Fixes sasview #1681: Generic Scattering Calculator produces empty 2D map on sld file
+* Fixes sasview #1674: Reloading a project in the same session duplicates the model/residuals in the Data Explorer
+* Fixes sasview #1671: pdh data loader bug in 4.x and ESS_GUI 5.x
+* Fixes sasview #1657: Loading project without fit_params entry causes empty fit window (v5.0.3)
+* Fixes sasview #1655: Corfunc and Invariant Perspectives not able to remove/swap data (5.x)
+* Fixes sasview #1654: 5.0.4 disable rather than remove constraints if do a fit on a single FitPage
+* Fixes sasview #1653: 5.0.4 new constraints checks over zealous on load project
+* Fixes sasview #1649: 4.x/5.x: Slicer Parameters control only appears in context menu once you have sliced
+* Fixes sasview #1648: 5.0.3 not updating radius_effective in GUI
+* Fixes sasview #1647: 4.x/5.x: Sector slicer tool Q plot could do with better resolution
+* Fixes sasview #1646: 4.x/5.x: Annulus slicer tool phi plot could do with better resolution
+* Fixes sasview #1640: Linux: SasView >5.0.1 binary cannot copy default custom_config.py
+* Fixes sasview #1616: ESS_GUI: Model label on plot keeps being reset
+* Fixes sasview #1611: Inconsistent behaviour of extrapolation Fit/Fix radio buttons in Invariant Perspective
+* Fixes sasview #1610: Chart in Invariant Perspective Status Dialog not displaying the low-Q contribution to Q*
+* Fixes sasview #1609: Changing Q-range limits in Invariant Perspective has no effect on extrapolations
+* Fixes sasview #1608: No Q-limit bars in Invariant Perspective
+* Fixes sasview #1607: Once extrapolation is turned on in the invariant it cannot be turned off
+* Fixes sasview #1606: Invariant does not report the total invariant
+* Fixes sasview #1605: Problem loading canSAS data into Invariant
+* Fixes sasview #1604: The Invariant low Q extrapolation choice is not honored
+* Fixes sasview #1600: v5 constrained value within single FitPage not being returned to gui
+* Fixes sasview #1589: 5.0 turn off or remove constraint ?
+* Fixes sasview #1583: calc.py throws erros after building SasView
+* Fixes sasview #1574: Invariant perspective fixes need to be ported to 5.x
+* Fixes sasview #1566: Default Checkboxes in data manager need changing
+* Fixes sasview #1557: GUI losing track of fitpage and plot associations
+* Fixes sasview #1547: Resolution is incorrectly handled in 5.x
+* Fixes sasview #1544: Need to examine 2D data pixel sizes
+* Fixes sasview #1542: Crosstalk between Corfunc and Invariant perspectives
+* Fixes sasview #1541: Invariant and the infinite multiplication of plots
+* Fixes sasview #1539: Corfunc requires two shots to populate the data name box
+* Fixes sasview #1537: Allow for replacing data in a Fit Page
+* Fixes sasview #1535: ESS_GUI: Existing common parameters not preserved between models in 5.x
+* Fixes sasview #1534: ESS_GUI: Something strange with 5.x and the .sasview folder
+* Fixes sasview #1532: Add a constraint checking mechanism
+* Fixes sasview #1526: Project Save/Load functionality of 4.x needs to be restored
+* Fixes sasview #1478: v5 & v4 TEst that P(Q)S(Q) plugin works
+* Fixes sasview #1472: Sort out the Invariant Perspective & Documentation (#1434 & #1461)
+* Fixes sasview #1469: 2D tools
+* Fixes sasview #1453: 5.1 gui initialisation issue for Onion model
+* Fixes sasview #1446: 5.0 dI uncertainty unavailable in batch mode
+* Fixes sasview #1408: Magnetic model documentation is inconsistent with code
+* Fixes sasview #1381: Slicer in 5.0 doesn't contain the batch, fitting, log/linear etc features
+* Fixes sasview #1340: 5.0 invariant mac not plotting
+* Fixes sasview #1243: Display title rather than filename in data browser (Trac #1213)
+* Fixes sasview #1137: Verify and document up_frac_i and up_frac_f calculations for magnetic models (Trac #1086)
+* Fixes sasview #863:  Make it easier to use the same fit set-up with different data sets (Trac #747)
+
+* Fixes sasmodels #367: Correlation length model documentation is wrong
+* Fixes sasmodels #210: Show all failing tests rather than stopping at the first
+
+New Models
+^^^^^^^^^^
+The following models have been added to the [Model Marketplace](http://marketplace.sasview.org/) since v5.0.0 was released:
+
+* Magnetic vortex in a disc
+* Field-dependent magnetic SANS of misaligned magnetic moments in bulk ferromagnets
+* SANS of bulk ferromagnets
+* Core_shell_ellipsoid_tied and core_shell_ellipsoid_repar
+* Lamellar_Slab_APL_nW
+* 5 Layer Core Shell Disc
+* Superparamagnetic Core-Shell Spheres with 3D field orientation
+* Superparamagnetic Core-Shell Spheres
+* Octahedron
+* Magnetically oriented, rotating and precessing anisometric particle (MORP)
+* Cumulants
+* Cumulants DLS
+* Peak Voigt
+* Long Cylinder
+* Sphere Concentration A
+* Binary Blend
+* Exponential
+* 2 Layer General Guinier Porod
+* Core double shell sphere filled with many cylinders in the core
+* Fractal S(q)
+* Mass Fractal S(q)
+* Core shell cuboid
+* Core shell sphere filled with a cylinder in the core
+* Correlated_spheres
+
+Known Issues
+^^^^^^^^^^^^
+At this time, the reinstated slider bars on plots for selecting the
+q-range for fitting do not work on linearized plots.
+
+All the known bugs/feature requests can be found in the issues on github.
+Note the sasmodels issues are now separate from the sasview issues (i.e. different repositories)
+
+[sasview](https://github.com/SasView/sasview/milestones)
+
+[sasmodels](https://github.com/SasView/sasmodels/milestones)
+
+
 New in Version 5.0.3
 --------------------
 This is a point release which fixes several issues, but in particular:
@@ -87,6 +243,11 @@ Known Issues
 ^^^^^^^^^^^^
 At this time, and unlike version 4.x, only fitting and P(r) inversion sessions can be saved as project files.
 
+There is also a bug which is stopping Batch Fitting from using the intensity uncertainty (dI) data if this 
+is present in the files being processed. As the default behaviour of normal Single Fitting is to automatically 
+use the dI data in the file if it is present, this means that the results of Single Fitting and Batch Fitting 
+the same data will differ.
+
 All the known bugs/feature requests can be found in the issues on github.
 Note the sasmodels issues are now separate from the sasview issues (i.e. different repositories)
 
@@ -1020,23 +1181,16 @@ users may wish to be aware of can be viewed at the following links:
 
 [sasmodels](https://github.com/SasView/sasmodels/milestones)
 
-All versions upto and including 5.0.2 - All systems
----------------------------------------------------
-A very long-standing error has been identified in the Invariant Analysis
-perspective. The value of the specific surface $Sv$ that is being returned
-is in fact *twice* the value that it should be.
+All 5.0.x versions / 4.2.2 - All systems
+----------------------------------------
+A problem has been identified in Version 4.2.2 which also affects all 5.0.x
+versions. The Easy Add/Multiply Editor dialog should not be used to combine
+a plugin model with a built-in model, or to combine two plugin models. In
+5.0.x the operation will fail, generating an error message in the Log Explorer
+similar to
 
-5.0.0 / 5.0.1 / 5.0.2 - All systems
------------------------------------
-In these versions, and unlike version 4.x, only fitting sessions can be saved as project files.
+     ModuleNotFoundError: No module named 'plugin_module_name'
 
-4.2.2 / 5.0.0 / 5.0.1 - All systems
------------------------------------
-A problem has been identified in Version 4.2.2 which also affects versions
-5.0.0 and 5.0.1. The Easy Add/Multiply Editor dialog should not be used to
-combine a plugin model with a built-in model, or to combine two plugin models.
-In 5.0.0 the operation will fail (generating an error message in the Log Explorer).
-Whilst in 5.0.1 the operation has been blocked until the problem can be fixed.
 If it is necessary to generate a plugin model from more than two built-in models,
 please edit the plugin model .py file directly and specify the combination of
 built-in models directly. For example::
@@ -1047,6 +1201,24 @@ built-in models directly. For example::
      model_info.name = 'MyBigPluginModel'
      model_info.description = 'For fitting pores in crystalline framework'
      Model = make_model_from_info(model_info)
+
+5.0.0 / 5.0.1 / 5.0.2 / 5.0.3 - All systems
+-------------------------------------------
+There is a bug which is stopping Batch Fitting from using the intensity 
+uncertainty (dI) data if this is present in the files being processed. 
+As the default behaviour of normal Single Fitting is to automatically 
+use the dI data in the file if it is present, this means that the results 
+of Single Fitting and Batch Fitting the same data will differ.
+
+All versions upto and including 5.0.2 - All systems
+---------------------------------------------------
+A very long-standing error has been identified in the Invariant Analysis
+perspective. The value of the specific surface $Sv$ that is being returned
+is in fact *twice* the value that it should be.
+
+5.0.0 / 5.0.1 / 5.0.2 - All systems
+-----------------------------------
+In these versions, and unlike version 4.x, only fitting sessions can be saved as project files.
 
 4.2.0 - All systems
 -------------------

installers/installer.iss

@@ -2,8 +2,8 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "SasView"
-#define MyAppVersion "5.0.3"
-#define MyAppPublisher "(c) 2009 - 2020, UTK, UMD, NIST, ORNL, ISIS, ESS, ILL, ANSTO, TU Delft and DLS"
+#define MyAppVersion "5.0.4"
+#define MyAppPublisher "(c) 2009 - 2021, UTK, UMD, NIST, ORNL, ISIS, ESS, ILL, ANSTO, TU Delft and DLS"
 #define MyAppURL "http://www.sasview.org"
 #define MyAppExeName "sasview.exe"
 
@@ -21,6 +21,7 @@ AppUpdatesURL={#MyAppURL}
 DefaultDirName=c:\{#MyAppName}-{#MyAppVersion}
 DefaultGroupName={#MyAppName}-{#MyAppVersion}
 DisableProgramGroupPage=yes
+DisableDirPage=no
 UsedUserAreasWarning=no
 LicenseFile=license.txt
 ArchitecturesInstallIn64BitMode=x64

installers/installer_generator64.py

@@ -32,6 +32,7 @@
 SetupIconFile = local_config.SetupIconFile_win
 LicenseFile = 'license.txt'
 DisableProgramGroupPage = 'yes'
+DisableDirPage = 'no'
 Compression = 'lzma'
 SolidCompression = 'yes'
 PrivilegesRequired = 'none'
@@ -345,6 +346,7 @@ def generate_installer():
     TEMPLATE += "DefaultDirName=%s\n" % str(DefaultDirName)
     TEMPLATE += "DefaultGroupName=%s\n" % str(DefaultGroupName)
     TEMPLATE += "DisableProgramGroupPage=%s\n" % str(DisableProgramGroupPage)
+    TEMPLATE += "DisableDirPage=%s\n" % str(DisableDirPage)
     TEMPLATE += "LicenseFile=%s\n" % str(LicenseFile)
     TEMPLATE += "OutputBaseFilename=%s\n" % str(OutputBaseFilename)
     TEMPLATE += "SetupIconFile=%s\n" % str(SetupIconFile)

installers/license.txt

@@ -18,4 +18,4 @@ sentence:
 *"This work benefited from the use of the SasView application, originally 
 developed under NSF award DMR-0520547."*
 
-Copyright (c) 2009-2020 UTK, UMD, ESS, NIST, ORNL, ISIS, ILL, DLS, TUD, BAM, ANSTO
+Copyright (c) 2009-2021 UTK, UMD, ESS, NIST, ORNL, ISIS, ILL, DLS, DUT, BAM, ANSTO