Merge pull request #53 from SasView/release-notes

Add Known issues for release 4.1 (section 3 of readme.txt)

sasview/README.txt

@@ -482,6 +482,44 @@ Release Notes
 3- Known Issues
 ===============
 
+
+   4.1- All systems:
+      The conversion to sasmodels infrastructure is ongoing and should be
+      completed in the next release. In the meantime this leads to a few known
+      issues:
+        - The way that orientation is defined is being refactored to address
+        long standing issues and comments.  In release 4.1 however only models
+        with symmetry (e.g. a=b) have been converted to the new definitions.
+        The rest (a <> b <> c - e.g. parellelepiped) maintain the same
+        definition as before and will be converted in 4.2.  Note that
+        orientational distribution also makes much more sense in the new
+        framework.  The documentation should indicate which definition is being
+        used for a given model.
+        - The infrastructure currently handles internal conversion of old style
+        models so that user created models in previous versions should continue
+        to work for now. At some point in the future such support will go away.
+        Everyone is encouraged to convert to the new structure which should be
+        relatively straight forward and provides a number of benefits. 
+        - In that vein, the distributed models and those generated by the new
+        plugin model editor are in the new format, however those generated by
+        sum|multiply models are the old style sum|multiply models. This should
+        also disappear in the near future 
+        - The on the fly discovery of plugin models and changes thereto behave
+        inconsistently.  If a change to a plugin model does not seem to
+        register, the Load Plugin Models (under fitting -> Plugin Model
+        Operations) can be used.  However, after calling Load Plugin Models, the
+        active plugin will no longer be loaded (even though the GUI looks like
+        it is) unless it is a sum|multiply model which works properly.  All
+        others will need to be recalled from the model dropdown menu to reload
+        the model into the calculation engine.  While it might be annoying it
+        does not appear to prevent SasView from working..
+        - The model code and documentation review is ongoing. At this time the
+        core shell parellelepiped is known to have the C shell effectively fixed
+        at 0 (noted in documentation) while the triaxial ellipsoid does not seem
+        to reproduce the limit of the oblate or prolate ellipsoid. If errors are
+        found and corrected, corrected versions will be uploaded to the
+        marketplace. 
+
    3.1- All systems:
         - The documentation window may take a few seconds to load the first time
           it is called. Also, an internet connection is required before