Changeset 1d2a4aa in sasview for docs/sphinx-docs/source/user

Timestamp:

Oct 2, 2018 11:39:42 AM (6 years ago)

Author:

smk78

Branches:

master, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, unittest-saveload

Children:

9849f8a

Parents:

73c51df

Message:

Updated release notes. Addresses #1146

File:

• docs/sphinx-docs/source/user/RELEASE.rst (modified) (12 diffs)

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

@@ -18 +18 @@
 
 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
+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).
 
-.. warning:: Old-style plugin models, including old sum|multiply models 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.
+.. warning:: Old-style plugin models, including old sum|multiply models, continue
+             to be supported (i.e. SasView will run them) in 4.x, although our
+             automatic on-the-fly translation may not cope in all use cases (see 
+             Known Issues below). However, this backward compatibility will be 
+             removed in 5.0 and users are therefore strongly encouraged to 
+             convert their custom models to the new API.
 
 Finally, the changes to orientation angles and orientational distribution
@@ -56 +58 @@
   objects have been rectified. Some questions remain however.
 * The known issue with the core_shell_parallelepiped model is now fixed.
+* An error in the be_polyelectrolyte model was identified and rectified, but 
+  the fix is yet to be validated.
 * A number of issues and inconsistencies with the creation of
   sum|multiply models have been rectified.
@@ -64 +68 @@
 * There are several data loading improvements.
 * There are several improvements to Save/Load Project.
+* The SasView version number now appears in Reports.
+* The Release Notes are now available from the program Help menu.
 * There have been numerous other bug fixes.
 
@@ -70 +76 @@
 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.
+magnetic scattering, and polydispersity distributions.
+
+Detailed advanced instructions for plugin writing and some scripting
+instructions have also been added.
+
+Concerns about the intended versus implemented meaning of some parameters
+in the bcc_paracrystal, fcc_paracrystal, and sc_paracrystal models have
+been brought to our attention. These have yet to be resolved and so a
+Warning has been placed on each of these models. Anyone who feels they
+may have the requisite expertise to investigate these concerns is strongly
+encouraged to contact the Developers!
 
 Other Work
@@ -90 +104 @@
 Bug Fixes
 ^^^^^^^^^
+* Fixes #  14: Loading a saved project is really really slow
 * Fixes # 260: Box integration does not update when entering values in dialog
 * Fixes # 446: Saving plot as PGF (not PDF!) format throws error
@@ -109 +124 @@
 * 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 # 818: “report button” followed by “save” makes an empty pdf file???
+* Fixes # 830: Check compliance of loader against NXcanSAS-1.0 release
 * 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 # 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
@@ -134 +150 @@
 * Fixes # 906: polydispersity not showing up in tabulated results
 * Fixes # 912: About box points to misleading contributors page on Github
+* Fixes # 913: Need to add Diamond developer and logo in relevant places
 * Fixes # 915: load project issues
 * Fixes # 916: Proper Logging
@@ -151 +168 @@
 * Fixes # 961: sasmodels tests should fail if the parameter name does not exist
 * Fixes # 962: star polymer typo in docs
+* Fixes # 966: Inconsistent chi2 reporting
 * Fixes # 967: no uncertainties errors on fitting parameters
 * Fixes # 969: About Box not picking up dls_logo.png
@@ -156 +174 @@
 * Fixes # 974: blacklist Intel HD 620/630 for double precision
 * Fixes # 978: load project fails for pages which have not been defined
+* Fixes # 980: Inconsistent results between Igor & SasView using Fractal Core-Shell model
 * Fixes # 983: Remove Nexus Loader
 * Fixes # 984: PDF reports are not being properly generated on Windows
@@ -166 +185 @@
 * 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 #1008: plugin model scaling not working?
 * Fixes #1010: Win64 build script not creating working executable
 * Fixes #1011: sld_test failing on ubuntu
+* Fixes #1012: ESS GUI not updating after fitting
 * Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded multiple times
 * Fixes #1018: add Boltzmann distribution
@@ -174 +194 @@
 * Fixes #1024: Update version numbers in master
 * Fixes #1025: Sum/multiply editor hangs
+* Fixes #1030: volume normalization for hollow shapes is different from solvent-filled shapes
 * 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 #1044: Unable to upload c file to marketplace
+* Fixes #1046: convert non builtin models in the marketplace to new API
 * 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 #1054: Check plugin & orientation descriptions in full docs once SasModels PR #57 is merged
 * 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 #1064: "Fitting did not converge!!!" error with a Sum|Multi plugin model
+* Fixes #1068: 2d data (from NG7) not loadiing - strange format?
 * Fixes #1069: GUI problem when using polydispersity/orientation distributions
 * Fixes #1070: Parameter error boxes should not be editable
+* Fixes #1072: Orientation distributions seem to depend on initial angle
 * Fixes #1079: Remove save button in report dialog on Mac
 * Fixes #1081: GUI problem with new orientation distribution
@@ -191 +217 @@
 * Fixes #1099: Erratic behaviour of Sum|Multi model in 4.1.2
 * Fixes #1101: Batch results page not displaying polydispersity values
+* Fixes #1103: Problem with plugin models on mac when using ER
+* Fixes #1128: AutoPlot generation for model documentation does not include background
 * Fixes #1131: OpencCl dialog does not open
 * Fixes #1132: Slit Size Calculator Tool not working
+* Fixes #1133: Reference in Acknowledging SasView box will need updating for release
+* Fixes #1134: sum/multi scale factor in 4.2 seems incorrect?
 * 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.
+* Fixes #1146: Need to add Release notes for 4.2
+* Fixes #1155: BE Polyelectrolyte errors
+* Fixes #1160: fix VR for core_shell_cylinder, fractal_core_shell and hollow_cylinder
+* Fixes #1163: Fix help note in sum of sum|multiply interface
+* Fixes #1164: Sphinx doc build does not support superscript or substitution
+* Fixes #1166: No longer able to report from multiple fit pages
+* Fixes #1167: Clarify the documentation for the Spinodal Model
+* Fixes #1173: more problems with math in plugins
+* Fixes #1174: Update list of contributors on webpage
+* Fixes #1176: Make Release Notes/Known Issues available from Help in Menu Bar
+* Fixes #1179: PDF Report should contain SasView Version Number
+* Fixes #1183: Test from creating new model reset all parameters to default in all open FitPages
+* Fixes #1184: 4.2.0 plugin is does not load earlier project properly
+
+**It is recommended that all users upgrade to this version, but your 
+attention is drawn to the Changes section above.**