Changeset beb4fec in sasview for installers/README.txt

Timestamp:

Sep 9, 2018 12:41:58 PM (6 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

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

Children:

aa1e5a69

Parents:

beb6da4 (diff), 16030b1 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

merge updates

File:

• installers/README.txt (modified) (14 diffs)

installers/README.txt

@@ -9 +9 @@
       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
+      available for 64 bit 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|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.
-      Finally, the new orientation angles and orientatinal distribution is now
-      also complete.
+
+      Finally, the changes to orientation angles and orientational distribution 
+      definitions are now also complete.
 
       - Changes
@@ -27 +31 @@
            aligned objects has been completely overhauled. It now differs from
            previous versions.
-         - Plugin models, including sum/multiply models, have completely migrated
+         - 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
@@ -41 +45 @@
            understanding the new orientation framework.
          - Problems with the computation of magnetic scattering from some
-           objects have been rectified. Some questions however remain.
+           objects have been rectified. Some questions remain however.
          - 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.
+           sum|multiply models have been rectified.
          - A Boltzmann distribution has been added for polydispersity/orientational
            distributions.
@@ -53 +57 @@
          - There have been numerous other bug fixes.
       - Documentation
-         Several sections of the help documentation have undergone significant
+           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.
+           
+           Two new tutorials have been added.
       - Other work
          - A Third-Party initiative has recently succeeded in getting SasView to
@@ -75 +81 @@
          Fixes # 467: Extend batch functionality to slicer
          Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly
-           (USANS slit smearing)
+                      (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
@@ -100 +106 @@
          Fixes # 861: cannot defined a structure factor plugin
          Fixes # 864: New Model Editor (simple plugin editor) error parsing
-           parameter line
+                      parameter line
          Fixes # 865: Plugin live discovery issues
          Fixes # 866: inform user when NaN is returned from compute
@@ -107 +113 @@
          Fixes # 876: Add check for HDF5 format in dataloader
          Fixes # 887: reorganize tree, separating the installed source from the
-           build source
+                      build source
          Fixes # 889: Refactor dataloader error handling infrastructure
          Fixes # 890: use new orientation definition for asymmetric shapes
@@ -126 +132 @@
          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
+                      marketplace
          Fixes # 932: Need to fix upload of data files to marketplace
          Fixes # 934: Slurp tutorial repo for tutorials
@@ -133 +139 @@
          Fixes # 950: Most of the readers don't close files properly.
          Fixes # 954: cross check dll/opencl/python polydispersity and
-           orientation results
+                      orientation results
          Fixes # 956: Possible problem with new doc build process
          Fixes # 961: sasmodels tests should fail if the parameter name does not exist
@@ -146 +152 @@
          Fixes # 985: Saving Project Fails
          Fixes # 986: Send to fitting overwrites theory page even if blank
-           FitPage has focus
+                      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
@@ -157 +163 @@
          Fixes #1011: sld_test failing on ubuntu
          Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded
-           multiple times
+                      multiple times
          Fixes #1018: add Boltzmann distribution
          Fixes #1021: add PDF documentation to website and document in wiki
-           release process
+                      release process
          Fixes #1024: Update version numbers in master
          Fixes #1025: Sum/multiply editor hangs
@@ -189 +195 @@
          Fixes #1148: Documentation for S(Q) models need updating
          Fixes #1128: AutoPlot generation for model documentation does not
-           include background
+                      include background
 
       It is recommended that all users upgrade to this version, but your
@@ -248 +254 @@
         adsorbed polymer/surfactant layer.
 
-        A correlation function may be interpreted in terms of an imaginary rod moving
-        through the structure of the material. G1(R) is the probability that a rod of
-        length R moving through the material has equal electron/neutron scattering
-        length density at either end. Hence a frequently occurring spacing within a
+        A correlation function may be interpreted in terms of an imaginary rod moving 
+        through the structure of the material. G1(R) is the probability that a rod of 
+        length R moving through the material has equal electron/neutron scattering 
+        length density at either end. Hence a frequently occurring spacing within a 
         structure manifests itself as a peak.
 
@@ -642 +648 @@
 =============================
 
-   *** Note 1:  The easiest approach to setting up the propoer environment to
+   *** Note 1:  The easiest approach to setting up the proper environment to
                 build from source is to use conda.  Instructions for setting up
                 using conda can be found at: