Changes in / [beb4fec:16030b1] in sasview


Ignore:
Location:
installers
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • installers/README-next-release.txt

    rbeb6da4 r0a71630  
    1010      marks the end of support for 32 bit operating systems and is only 
    1111      available for 64 bit operating systems. 
    12  
    13       With this version the change to the new model API and plugins infrastructure 
    14       begun with 4.0 is essentially complete (though extensions are in the works 
    15       and more are likely they should remain backwardly compatible with previous 
     12       
     13      With this version the change to the new model API and plugins infrastructure  
     14      begun with 4.0 is essentially complete (though extensions are in the works  
     15      and more are likely they should remain backwardly compatible with previous  
    1616      versions of SasView). 
    17  
     17       
    1818      NOTE: Old-style plugin models, including old sum|multiply models will continue 
    1919      to be supported (i.e. SasView will be able to run them) in 4.x. However, 
    2020      the expectation is that such support will be removed in 5.0 and everyone 
    2121      is strongly encouraged to convert their custom models to the new API. 
    22  
    23       Finally, the changes to orientation angles and orientational distribution 
     22       
     23      Finally, the changes to orientation angles and orientational distribution  
    2424      definitions are now also complete. 
    25  
     25       
    2626      - Changes 
    2727         - The infrastucture for calculating 2D patterns from 3D orientated objects 
    … …  
    6262           advanced instructions for plugin writing and some scripting 
    6363           instructions have been added. 
    64  
    65            Two new tutorials have been added. 
     64           Two new tutorials have been added. 
    6665      - Other work 
    6766         - A Third-Party initiative has recently succeeded in getting SasView to 
    … …  
    9796         Fixes # 784: Add 3D integral to Correlation Function analysis 
    9897         Fixes # 786: core_shell_parallelepiped 1-D model is incorrect 
    99          Fixes # 818: "report button" followed by "save" makes an empty pdf file 
     98         Fixes # 818: “report button” followed by “save” makes an empty pdf file 
    10099         Fixes # 838: Fix model download from marketplace 
    101100         Fixes # 848: can't save analysis when only one fit page 
    102          Fixes # 849: Load Folder should ignore files starting with "." 
     101         Fixes # 849: Load Folder should ignore files starting with . 
    103102         Fixes # 852: More unit tests, especially for oriented or 2d models 
    104103         Fixes # 854: remove unnecessary sleep() in fitting perspective 
    … …  
    150149         Fixes # 983: Remove Nexus Loader 
    151150         Fixes # 984: PDF reports are not being properly generated on Windows 
    152          Fixes # 985: Saving Project Fails 
    153          Fixes # 986: Send to fitting overwrites theory page even if blank 
     151         Fixes # 985: Saving Project Fails   
     152         Fixes # 986: Send to fitting overwrites theory page even if blank  
    154153                      FitPage has focus 
    155154         Fixes # 990: utest_sasview.py giving different results than run_one.py 
    … …  
    205204      have been made in the year since the previous release. Full release notes 
    206205      will be compiled prior to the full release 4.2.0. 
    207  
     206     
    208207      Highlights are: 
    209208        - Infrastucture for calculating 2D patterns from 3D orientated objects 
    210209          has now been totally refactored 
    211         - Plugins have completely migrated to the new infrastructure now, 
    212           including sum/multiply models 
     210        - Plugins have completely migrated to the new infrastructure now,  
     211              including sum/multiply models 
    213212        - Some batch slicing options have been introduced 
    214213        - The known issue with the core_shell_parallelepiped is now fixed 
    … …  
    217216        - Numerous bug fixes 
    218217        - Lots of documentation enhancement 
    219  
     218     
    220219      In the meantime please report any bugs or issues found while using this beta 
    221220 
    … …  
    248247      This incremental release brings a series of new features and improvements, 
    249248      and a host of bug fixes. Of particular note are: 
    250  
     249       
    251250      - Correlation Function Analysis (Corfunc) 
    252         This performs a correlation function analysis of one-dimensional SAXS/SANS data, 
    253         or generates a model-independent volume fraction profile from the SANS from an 
    254         adsorbed polymer/surfactant layer. 
    255  
    256         A correlation function may be interpreted in terms of an imaginary rod moving 
    257         through the structure of the material. G1(R) is the probability that a rod of 
    258         length R moving through the material has equal electron/neutron scattering 
    259         length density at either end. Hence a frequently occurring spacing within a 
    260         structure manifests itself as a peak. 
    261  
    262         A volume fraction profile \Phi(z) describes how the density of polymer 
    263         segments/surfactant molecules varies with distance from an (assumed locally flat) 
    264         interface. 
     251        This performs a correlation function analysis of one-dimensional SAXS/SANS data,  
     252        or generates a model-independent volume fraction profile from the SANS from an  
     253        adsorbed polymer/surfactant layer. 
     254 
     255        A correlation function may be interpreted in terms of an imaginary rod moving  
     256        through the structure of the material. Γ1D(R) is the probability that a rod of  
     257        length R moving through the material has equal electron/neutron scattering  
     258        length density at either end. Hence a frequently occurring spacing within a  
     259        structure manifests itself as a peak. 
     260 
     261        A volume fraction profile \Phi(z) describes how the density of polymer  
     262        segments/surfactant molecules varies with distance from an (assumed locally flat) 
     263        interface. 
    265264 
    266265      - Fitting of SESANS Data 
    267         Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will 
    268         be plotted against the correct axes and models will automatically perform a Hankel 
    269         transform in order to calculate SESANS from a SANS model. 
     266        Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will  
     267        be plotted against the correct axes and models will automatically perform a Hankel  
     268        transform in order to calculate SESANS from a SANS model. 
    270269 
    271270      - Documentation 
    272         The documentation has undergone significant checking and updating. 
     271        The documentation has undergone significant checking and updating. 
    273272 
    274273      - Improvements 
    … …  
    330329         - Old custom models should now still work 
    331330            - '''NOTE:''' These will be deprecated in a future version. Old 
    332               custom models should be converted to the new model format which 
    333               is now the same as the built in models and offers much better 
    334               support. 
     331            custom models should be converted to the new model format which 
     332            is now the same as the built in models and offers much better 
     333            support. 
    335334         - Custom model editor now creates new style models 
    336335         - Custom model editor supports better error checking 
    … …  
    343342         - The active optimizer is now listed on the top of the fit panel. 
    344343         - Linear fits now update qmin and max when the x scale limits are 
    345            changed.  Also the plot range no longer resets after a fit. 
     344         changed.  Also the plot range no longer resets after a fit. 
    346345      - Bug fixes 
    347346         - Fixes bug #511 Errors in linearized fits and clean up of interface 
    348            including Kratky representation 
     347         including Kratky representation 
    349348         - Fixes bug #186 Data operation Tool now executes when something is 
    350            entered in the text box and does not wait for the user to hit enter 
     349         entered in the text box and does not wait for the user to hit enter 
    351350         - Fixes bug #459 plot context menu bug 
    352351         - Fixes bug #559 copy to clipboard in graph menu broken 
    … …  
    650649   *** Note 1:  The easiest approach to setting up the proper environment to 
    651650                build from source is to use conda.  Instructions for setting up 
    652                 and using conda can be found at: 
    653                     http://trac.sasview.org/wiki/DevNotes/CondaDevSetup 
     651                using conda can be found at:  
     652                http://trac.sasview.org/wiki/DevNotes/CondaDevSetup 
    654653   *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of 
    655654                the following.  However it is highly recommended that any 
    … …  
    657656                new version. 
    658657   *** Note 3:  Much more information is available at www.sasview.org under links. 
    659                 Look in the 'For Developers' section and particularly the wiki at 
     658                    Look in the 'For Developers' section and particularly the wiki at 
    660659                www.sasview.org/trac/wiki. 
    661660 
    … …  
    670669              git clone https://github.com/Sasview/sasmodels.git 
    671670              git clone https://github.com/bumps/bumps.git 
     671          - to install a specific version 
    672672 
    673673        - Build, install and run a specific release 
    … …  
    689689            changing the C model files 
    690690 
    691         - For the latest list of dependencies see the appropriate yml file in 
    692           the SasView repo at sasview/build_tools/conda/ymls 
     691        -For the latest list of dependencies see the appropriate yml file in 
     692          the SasView repo at sasview/build_tools/conda/ymls  
    693693 
    694694 
    … …  
    709709      issues: 
    710710        - The way that orientation is defined is being refactored to address 
    711           long standing issues and comments.  In release 4.1 however only models 
    712           with symmetry (e.g. a=b) have been converted to the new definitions. 
    713           The rest (a <> b <> c - e.g. parellelepiped) maintain the same 
    714           definition as before and will be converted in 4.2.  Note that 
    715           orientational distribution also makes much more sense in the new 
    716           framework.  The documentation should indicate which definition is being 
    717           used for a given model. 
     711        long standing issues and comments.  In release 4.1 however only models 
     712        with symmetry (e.g. a=b) have been converted to the new definitions. 
     713        The rest (a <> b <> c - e.g. parellelepiped) maintain the same 
     714        definition as before and will be converted in 4.2.  Note that 
     715        orientational distribution also makes much more sense in the new 
     716        framework.  The documentation should indicate which definition is being 
     717        used for a given model. 
    718718        - The infrastructure currently handles internal conversion of old style 
    719           models so that user created models in previous versions should continue 
    720           to work for now. At some point in the future such support will go away. 
    721           Everyone is encouraged to convert to the new structure which should be 
    722           relatively straight forward and provides a number of benefits. 
     719        models so that user created models in previous versions should continue 
     720        to work for now. At some point in the future such support will go away. 
     721        Everyone is encouraged to convert to the new structure which should be 
     722        relatively straight forward and provides a number of benefits.  
    723723        - In that vein, the distributed models and those generated by the new 
    724           plugin model editor are in the new format, however those generated by 
    725           sum|multiply models are the old style sum|multiply models. This should 
    726           also disappear in the near future 
     724        plugin model editor are in the new format, however those generated by 
     725        sum|multiply models are the old style sum|multiply models. This should 
     726        also disappear in the near future  
    727727        - The on the fly discovery of plugin models and changes thereto behave 
    728           inconsistently.  If a change to a plugin model does not seem to 
    729           register, the Load Plugin Models (under fitting -> Plugin Model 
    730           Operations) can be used.  However, after calling Load Plugin Models, the 
    731           active plugin will no longer be loaded (even though the GUI looks like 
    732           it is) unless it is a sum|multiply model which works properly.  All 
    733           others will need to be recalled from the model dropdown menu to reload 
    734           the model into the calculation engine.  While it might be annoying it 
    735           does not appear to prevent SasView from working.. 
     728        inconsistently.  If a change to a plugin model does not seem to 
     729        register, the Load Plugin Models (under fitting -> Plugin Model 
     730        Operations) can be used.  However, after calling Load Plugin Models, the 
     731        active plugin will no longer be loaded (even though the GUI looks like 
     732        it is) unless it is a sum|multiply model which works properly.  All 
     733        others will need to be recalled from the model dropdown menu to reload 
     734        the model into the calculation engine.  While it might be annoying it 
     735        does not appear to prevent SasView from working.. 
    736736        - The model code and documentation review is ongoing. At this time the 
    737           core shell parellelepiped is known to have the C shell effectively fixed 
    738           at 0 (noted in documentation) while the triaxial ellipsoid does not seem 
    739           to reproduce the limit of the oblate or prolate ellipsoid. If errors are 
    740           found and corrected, corrected versions will be uploaded to the 
    741           marketplace. 
    742  
     737        core shell parellelepiped is known to have the C shell effectively fixed 
     738        at 0 (noted in documentation) while the triaxial ellipsoid does not seem 
     739        to reproduce the limit of the oblate or prolate ellipsoid. If errors are 
     740        found and corrected, corrected versions will be uploaded to the 
     741        marketplace.  
     742    
    743743   3.1- All systems: 
    744744        - The documentation window may take a few seconds to load the first time 

  • installers/README.txt

    rbeb6da4 r16030b1  
    2020      the expectation is that such support will be removed in 5.0 and everyone 
    2121      is strongly encouraged to convert their custom models to the new API. 
    22  
     22       
    2323      Finally, the changes to orientation angles and orientational distribution  
    2424      definitions are now also complete. 
    25  
     25       
    2626      - Changes 
    2727         - The infrastucture for calculating 2D patterns from 3D orientated objects 
    … …  
    6262           advanced instructions for plugin writing and some scripting 
    6363           instructions have been added. 
    64             
    65            Two new tutorials have been added. 
     64           Two new tutorials have been added. 
    6665      - Other work 
    6766         - A Third-Party initiative has recently succeeded in getting SasView to 
    … …  
    9796         Fixes # 784: Add 3D integral to Correlation Function analysis 
    9897         Fixes # 786: core_shell_parallelepiped 1-D model is incorrect 
    99          Fixes # 818: "report button" followed by "save" makes an empty pdf file 
     98         Fixes # 818: “report buttonâ€ￜ followed by “saveâ€ￜ makes an empty pdf file 
    10099         Fixes # 838: Fix model download from marketplace 
    101100         Fixes # 848: can't save analysis when only one fit page 
    … …  
    150149         Fixes # 983: Remove Nexus Loader 
    151150         Fixes # 984: PDF reports are not being properly generated on Windows 
    152          Fixes # 985: Saving Project Fails 
    153          Fixes # 986: Send to fitting overwrites theory page even if blank 
     151         Fixes # 985: Saving Project Fails   
     152         Fixes # 986: Send to fitting overwrites theory page even if blank  
    154153                      FitPage has focus 
    155154         Fixes # 990: utest_sasview.py giving different results than run_one.py 
    … …  
    205204      have been made in the year since the previous release. Full release notes 
    206205      will be compiled prior to the full release 4.2.0. 
    207  
     206     
    208207      Highlights are: 
    209208        - Infrastucture for calculating 2D patterns from 3D orientated objects 
    210209          has now been totally refactored 
    211         - Plugins have completely migrated to the new infrastructure now, 
    212           including sum/multiply models 
     210        - Plugins have completely migrated to the new infrastructure now,  
     211              including sum/multiply models 
    213212        - Some batch slicing options have been introduced 
    214213        - The known issue with the core_shell_parallelepiped is now fixed 
    … …  
    217216        - Numerous bug fixes 
    218217        - Lots of documentation enhancement 
    219  
     218     
    220219      In the meantime please report any bugs or issues found while using this beta 
    221220 
    … …  
    248247      This incremental release brings a series of new features and improvements, 
    249248      and a host of bug fixes. Of particular note are: 
    250  
     249       
    251250      - Correlation Function Analysis (Corfunc) 
    252         This performs a correlation function analysis of one-dimensional SAXS/SANS data, 
    253         or generates a model-independent volume fraction profile from the SANS from an 
    254         adsorbed polymer/surfactant layer. 
    255  
    256         A correlation function may be interpreted in terms of an imaginary rod moving  
    257         through the structure of the material. G1(R) is the probability that a rod of  
    258         length R moving through the material has equal electron/neutron scattering  
    259         length density at either end. Hence a frequently occurring spacing within a  
    260         structure manifests itself as a peak. 
    261  
    262         A volume fraction profile \Phi(z) describes how the density of polymer 
    263         segments/surfactant molecules varies with distance from an (assumed locally flat) 
    264         interface. 
     251        This performs a correlation function analysis of one-dimensional SAXS/SANS data,  
     252        or generates a model-independent volume fraction profile from the SANS from an  
     253        adsorbed polymer/surfactant layer. 
     254 
     255        A correlation function may be interpreted in terms of an imaginary rod moving  
     256        through the structure of the material. ÃŜ“1D(R) is the probability that a rod of  
     257        length R moving through the material has equal electron/neutron scattering  
     258        length density at either end. Hence a frequently occurring spacing within a  
     259        structure manifests itself as a peak. 
     260 
     261        A volume fraction profile \Phi(z) describes how the density of polymer  
     262        segments/surfactant molecules varies with distance from an (assumed locally flat) 
     263        interface. 
    265264 
    266265      - Fitting of SESANS Data 
    267         Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will 
    268         be plotted against the correct axes and models will automatically perform a Hankel 
    269         transform in order to calculate SESANS from a SANS model. 
     266        Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will  
     267        be plotted against the correct axes and models will automatically perform a Hankel  
     268        transform in order to calculate SESANS from a SANS model. 
    270269 
    271270      - Documentation 
    272         The documentation has undergone significant checking and updating. 
     271        The documentation has undergone significant checking and updating. 
    273272 
    274273      - Improvements 
    … …  
    330329         - Old custom models should now still work 
    331330            - '''NOTE:''' These will be deprecated in a future version. Old 
    332               custom models should be converted to the new model format which 
    333               is now the same as the built in models and offers much better 
    334               support. 
     331            custom models should be converted to the new model format which 
     332            is now the same as the built in models and offers much better 
     333            support. 
    335334         - Custom model editor now creates new style models 
    336335         - Custom model editor supports better error checking 
    … …  
    343342         - The active optimizer is now listed on the top of the fit panel. 
    344343         - Linear fits now update qmin and max when the x scale limits are 
    345            changed.  Also the plot range no longer resets after a fit. 
     344         changed.  Also the plot range no longer resets after a fit. 
    346345      - Bug fixes 
    347346         - Fixes bug #511 Errors in linearized fits and clean up of interface 
    348            including Kratky representation 
     347         including Kratky representation 
    349348         - Fixes bug #186 Data operation Tool now executes when something is 
    350            entered in the text box and does not wait for the user to hit enter 
     349         entered in the text box and does not wait for the user to hit enter 
    351350         - Fixes bug #459 plot context menu bug 
    352351         - Fixes bug #559 copy to clipboard in graph menu broken 
    … …  
    650649   *** Note 1:  The easiest approach to setting up the proper environment to 
    651650                build from source is to use conda.  Instructions for setting up 
    652                 using conda can be found at: 
     651                using conda can be found at:  
    653652                http://trac.sasview.org/wiki/DevNotes/CondaDevSetup 
    654653   *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of 
    … …  
    657656                new version. 
    658657   *** Note 3:  Much more information is available at www.sasview.org under links. 
    659                 Look in the 'For Developers' section and particularly the wiki at 
     658                    Look in the 'For Developers' section and particularly the wiki at 
    660659                www.sasview.org/trac/wiki. 
    661660 
    … …  
    670669              git clone https://github.com/Sasview/sasmodels.git 
    671670              git clone https://github.com/bumps/bumps.git 
     671          - to install a specific version 
    672672 
    673673        - Build, install and run a specific release 
    … …  
    689689            changing the C model files 
    690690 
    691         - For the latest list of dependencies see the appropriate yml file in 
    692           the SasView repo at sasview/build_tools/conda/ymls 
     691        -For the latest list of dependencies see the appropriate yml file in 
     692          the SasView repo at sasview/build_tools/conda/ymls  
    693693 
    694694 
    … …  
    709709      issues: 
    710710        - The way that orientation is defined is being refactored to address 
    711           long standing issues and comments.  In release 4.1 however only models 
    712           with symmetry (e.g. a=b) have been converted to the new definitions. 
    713           The rest (a <> b <> c - e.g. parellelepiped) maintain the same 
    714           definition as before and will be converted in 4.2.  Note that 
    715           orientational distribution also makes much more sense in the new 
    716           framework.  The documentation should indicate which definition is being 
    717           used for a given model. 
     711        long standing issues and comments.  In release 4.1 however only models 
     712        with symmetry (e.g. a=b) have been converted to the new definitions. 
     713        The rest (a <> b <> c - e.g. parellelepiped) maintain the same 
     714        definition as before and will be converted in 4.2.  Note that 
     715        orientational distribution also makes much more sense in the new 
     716        framework.  The documentation should indicate which definition is being 
     717        used for a given model. 
    718718        - The infrastructure currently handles internal conversion of old style 
    719           models so that user created models in previous versions should continue 
    720           to work for now. At some point in the future such support will go away. 
    721           Everyone is encouraged to convert to the new structure which should be 
    722           relatively straight forward and provides a number of benefits. 
     719        models so that user created models in previous versions should continue 
     720        to work for now. At some point in the future such support will go away. 
     721        Everyone is encouraged to convert to the new structure which should be 
     722        relatively straight forward and provides a number of benefits.  
    723723        - In that vein, the distributed models and those generated by the new 
    724           plugin model editor are in the new format, however those generated by 
    725           sum|multiply models are the old style sum|multiply models. This should 
    726           also disappear in the near future 
     724        plugin model editor are in the new format, however those generated by 
     725        sum|multiply models are the old style sum|multiply models. This should 
     726        also disappear in the near future  
    727727        - The on the fly discovery of plugin models and changes thereto behave 
    728           inconsistently.  If a change to a plugin model does not seem to 
    729           register, the Load Plugin Models (under fitting -> Plugin Model 
    730           Operations) can be used.  However, after calling Load Plugin Models, the 
    731           active plugin will no longer be loaded (even though the GUI looks like 
    732           it is) unless it is a sum|multiply model which works properly.  All 
    733           others will need to be recalled from the model dropdown menu to reload 
    734           the model into the calculation engine.  While it might be annoying it 
    735           does not appear to prevent SasView from working.. 
     728        inconsistently.  If a change to a plugin model does not seem to 
     729        register, the Load Plugin Models (under fitting -> Plugin Model 
     730        Operations) can be used.  However, after calling Load Plugin Models, the 
     731        active plugin will no longer be loaded (even though the GUI looks like 
     732        it is) unless it is a sum|multiply model which works properly.  All 
     733        others will need to be recalled from the model dropdown menu to reload 
     734        the model into the calculation engine.  While it might be annoying it 
     735        does not appear to prevent SasView from working.. 
    736736        - The model code and documentation review is ongoing. At this time the 
    737           core shell parellelepiped is known to have the C shell effectively fixed 
    738           at 0 (noted in documentation) while the triaxial ellipsoid does not seem 
    739           to reproduce the limit of the oblate or prolate ellipsoid. If errors are 
    740           found and corrected, corrected versions will be uploaded to the 
    741           marketplace. 
    742  
     737        core shell parellelepiped is known to have the C shell effectively fixed 
     738        at 0 (noted in documentation) while the triaxial ellipsoid does not seem 
     739        to reproduce the limit of the oblate or prolate ellipsoid. If errors are 
     740        found and corrected, corrected versions will be uploaded to the 
     741        marketplace.  
     742    
    743743   3.1- All systems: 
    744744        - The documentation window may take a few seconds to load the first time 
Note: See TracChangeset for help on using the changeset viewer.