Changes in installers/README.txt [16030b1:beb6da4] in sasview
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
installers/README.txt
r16030b1 rbeb6da4 9 9 some significant changes from previous versions. Further, as promised, it 10 10 marks the end of support for 32 bit operating systems and is only 11 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 16 versions of SasView). 17 18 NOTE: Old-style plugin models, including old sum|multiply models will continue 11 available for 64bit operating systems. With this version the change to the 12 new model API and plugins infrastructure begun with 4.0 is essentially 13 complete (though extensions are in the works and more are likely they 14 should remain backwardly compatible with previous versions of SasView). 15 NOTE: old style plugin models, including old sum|mul mocels will continue 19 16 to be supported (i.e. SasView will be able to run them) in 4.x. However, 20 17 the expectation is that such support will be removed in 5.0 and everyone 21 18 is strongly encouraged to convert their custom models to the new API. 22 23 Finally, the changes to orientation angles and orientational distribution 24 definitions are now also complete. 25 19 Finally, the new orientation angles and orientatinal distribution is now 20 also complete. 21 26 22 - Changes 27 23 - The infrastucture for calculating 2D patterns from 3D orientated objects … … 31 27 aligned objects has been completely overhauled. It now differs from 32 28 previous versions. 33 - Plugin models, including sum |multiply models, have completely migrated29 - Plugin models, including sum/multiply models, have completely migrated 34 30 to the new infrastructure. NOTE that 3.x type models as well as early, 35 31 intermediate 4.x type models, including those generated by sum|multiply … … 45 41 understanding the new orientation framework. 46 42 - Problems with the computation of magnetic scattering from some 47 objects have been rectified. Some questions remain however.43 objects have been rectified. Some questions however remain. 48 44 - The known issue with the core_shell_parallelepiped model is now fixed. 49 45 - A number of issues and inconsistencies with the creation of 50 sum| multiplymodels have been rectified.46 sum|product models have been rectified. 51 47 - A Boltzmann distribution has been added for polydispersity/orientational 52 48 distributions. … … 57 53 - There have been numerous other bug fixes. 58 54 - Documentation 59 55 Several sections of the help documentation have undergone significant 60 56 checking and updating, particularly those relating to orientation, 61 57 magnetic scattering, and polydispersity distributions. Detailed 62 58 advanced instructions for plugin writing and some scripting 63 59 instructions have been added. 64 Two new tutorials have been added.65 60 - Other work 66 61 - A Third-Party initiative has recently succeeded in getting SasView to … … 80 75 Fixes # 467: Extend batch functionality to slicer 81 76 Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly 82 77 (USANS slit smearing) 83 78 Fixes # 499: create sin(x)/x, 2*J1(x)/x and 3*j1(x)/x functions 84 79 Fixes # 510: Build PDF documentation along with HTML … … 96 91 Fixes # 784: Add 3D integral to Correlation Function analysis 97 92 Fixes # 786: core_shell_parallelepiped 1-D model is incorrect 98 Fixes # 818: ââ¬Åreport buttonââ¬ï¿œ followed by ââ¬Åsaveââ¬ï¿œmakes an empty pdf file93 Fixes # 818: "report button" followed by "save" makes an empty pdf file 99 94 Fixes # 838: Fix model download from marketplace 100 95 Fixes # 848: can't save analysis when only one fit page … … 105 100 Fixes # 861: cannot defined a structure factor plugin 106 101 Fixes # 864: New Model Editor (simple plugin editor) error parsing 107 102 parameter line 108 103 Fixes # 865: Plugin live discovery issues 109 104 Fixes # 866: inform user when NaN is returned from compute … … 112 107 Fixes # 876: Add check for HDF5 format in dataloader 113 108 Fixes # 887: reorganize tree, separating the installed source from the 114 109 build source 115 110 Fixes # 889: Refactor dataloader error handling infrastructure 116 111 Fixes # 890: use new orientation definition for asymmetric shapes … … 131 126 Fixes # 930: fitting help says chisq is normalized to number of points 132 127 Fixes # 931: Allow admins to edit all models and upload data etc on 133 128 marketplace 134 129 Fixes # 932: Need to fix upload of data files to marketplace 135 130 Fixes # 934: Slurp tutorial repo for tutorials … … 138 133 Fixes # 950: Most of the readers don't close files properly. 139 134 Fixes # 954: cross check dll/opencl/python polydispersity and 140 135 orientation results 141 136 Fixes # 956: Possible problem with new doc build process 142 137 Fixes # 961: sasmodels tests should fail if the parameter name does not exist … … 149 144 Fixes # 983: Remove Nexus Loader 150 145 Fixes # 984: PDF reports are not being properly generated on Windows 151 Fixes # 985: Saving Project Fails 152 Fixes # 986: Send to fitting overwrites theory page even if blank 153 146 Fixes # 985: Saving Project Fails 147 Fixes # 986: Send to fitting overwrites theory page even if blank 148 FitPage has focus 154 149 Fixes # 990: utest_sasview.py giving different results than run_one.py 155 150 Fixes # 993: Windows x64 versions not installing to correct folder … … 162 157 Fixes #1011: sld_test failing on ubuntu 163 158 Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded 164 159 multiple times 165 160 Fixes #1018: add Boltzmann distribution 166 161 Fixes #1021: add PDF documentation to website and document in wiki 167 162 release process 168 163 Fixes #1024: Update version numbers in master 169 164 Fixes #1025: Sum/multiply editor hangs … … 194 189 Fixes #1148: Documentation for S(Q) models need updating 195 190 Fixes #1128: AutoPlot generation for model documentation does not 196 191 include background 197 192 198 193 It is recommended that all users upgrade to this version, but your … … 204 199 have been made in the year since the previous release. Full release notes 205 200 will be compiled prior to the full release 4.2.0. 206 201 207 202 Highlights are: 208 203 - Infrastucture for calculating 2D patterns from 3D orientated objects 209 204 has now been totally refactored 210 - Plugins have completely migrated to the new infrastructure now, 211 205 - Plugins have completely migrated to the new infrastructure now, 206 including sum/multiply models 212 207 - Some batch slicing options have been introduced 213 208 - The known issue with the core_shell_parallelepiped is now fixed … … 216 211 - Numerous bug fixes 217 212 - Lots of documentation enhancement 218 213 219 214 In the meantime please report any bugs or issues found while using this beta 220 215 … … 247 242 This incremental release brings a series of new features and improvements, 248 243 and a host of bug fixes. Of particular note are: 249 244 250 245 - Correlation Function Analysis (Corfunc) 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 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 260 261 A volume fraction profile \Phi(z) describes how the density of polymer 262 263 246 This performs a correlation function analysis of one-dimensional SAXS/SANS data, 247 or generates a model-independent volume fraction profile from the SANS from an 248 adsorbed polymer/surfactant layer. 249 250 A correlation function may be interpreted in terms of an imaginary rod moving 251 through the structure of the material. G1(R) is the probability that a rod of 252 length R moving through the material has equal electron/neutron scattering 253 length density at either end. Hence a frequently occurring spacing within a 254 structure manifests itself as a peak. 255 256 A volume fraction profile \Phi(z) describes how the density of polymer 257 segments/surfactant molecules varies with distance from an (assumed locally flat) 258 interface. 264 259 265 260 - Fitting of SESANS Data 266 Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will267 be plotted against the correct axes and models will automatically perform a Hankel 268 261 Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will 262 be plotted against the correct axes and models will automatically perform a Hankel 263 transform in order to calculate SESANS from a SANS model. 269 264 270 265 - Documentation 271 266 The documentation has undergone significant checking and updating. 272 267 273 268 - Improvements … … 329 324 - Old custom models should now still work 330 325 - '''NOTE:''' These will be deprecated in a future version. Old 331 custom models should be converted to the new model format which332 is now the same as the built in models and offers much better333 support.326 custom models should be converted to the new model format which 327 is now the same as the built in models and offers much better 328 support. 334 329 - Custom model editor now creates new style models 335 330 - Custom model editor supports better error checking … … 342 337 - The active optimizer is now listed on the top of the fit panel. 343 338 - Linear fits now update qmin and max when the x scale limits are 344 changed. Also the plot range no longer resets after a fit.339 changed. Also the plot range no longer resets after a fit. 345 340 - Bug fixes 346 341 - Fixes bug #511 Errors in linearized fits and clean up of interface 347 including Kratky representation342 including Kratky representation 348 343 - Fixes bug #186 Data operation Tool now executes when something is 349 entered in the text box and does not wait for the user to hit enter344 entered in the text box and does not wait for the user to hit enter 350 345 - Fixes bug #459 plot context menu bug 351 346 - Fixes bug #559 copy to clipboard in graph menu broken … … 647 642 ============================= 648 643 649 *** Note 1: The easiest approach to setting up the prop er environment to644 *** Note 1: The easiest approach to setting up the propoer environment to 650 645 build from source is to use conda. Instructions for setting up 651 using conda can be found at: 646 using conda can be found at: 652 647 http://trac.sasview.org/wiki/DevNotes/CondaDevSetup 653 648 *** Note 2: If you have EXE or ZIP SasView installer, you won't need any of … … 656 651 new version. 657 652 *** Note 3: Much more information is available at www.sasview.org under links. 658 653 Look in the 'For Developers' section and particularly the wiki at 659 654 www.sasview.org/trac/wiki. 660 655 … … 669 664 git clone https://github.com/Sasview/sasmodels.git 670 665 git clone https://github.com/bumps/bumps.git 671 - to install a specific version672 666 673 667 - Build, install and run a specific release … … 689 683 changing the C model files 690 684 691 - For the latest list of dependencies see the appropriate yml file in692 the SasView repo at sasview/build_tools/conda/ymls 685 - For the latest list of dependencies see the appropriate yml file in 686 the SasView repo at sasview/build_tools/conda/ymls 693 687 694 688 … … 709 703 issues: 710 704 - The way that orientation is defined is being refactored to address 711 long standing issues and comments. In release 4.1 however only models712 with symmetry (e.g. a=b) have been converted to the new definitions.713 The rest (a <> b <> c - e.g. parellelepiped) maintain the same714 definition as before and will be converted in 4.2. Note that715 orientational distribution also makes much more sense in the new716 framework. The documentation should indicate which definition is being717 used for a given model.705 long standing issues and comments. In release 4.1 however only models 706 with symmetry (e.g. a=b) have been converted to the new definitions. 707 The rest (a <> b <> c - e.g. parellelepiped) maintain the same 708 definition as before and will be converted in 4.2. Note that 709 orientational distribution also makes much more sense in the new 710 framework. The documentation should indicate which definition is being 711 used for a given model. 718 712 - The infrastructure currently handles internal conversion of old style 719 models so that user created models in previous versions should continue720 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 be722 relatively straight forward and provides a number of benefits.713 models so that user created models in previous versions should continue 714 to work for now. At some point in the future such support will go away. 715 Everyone is encouraged to convert to the new structure which should be 716 relatively straight forward and provides a number of benefits. 723 717 - In that vein, the distributed models and those generated by the new 724 plugin model editor are in the new format, however those generated by725 sum|multiply models are the old style sum|multiply models. This should726 also disappear in the near future718 plugin model editor are in the new format, however those generated by 719 sum|multiply models are the old style sum|multiply models. This should 720 also disappear in the near future 727 721 - The on the fly discovery of plugin models and changes thereto behave 728 inconsistently. If a change to a plugin model does not seem to729 register, the Load Plugin Models (under fitting -> Plugin Model730 Operations) can be used. However, after calling Load Plugin Models, the731 active plugin will no longer be loaded (even though the GUI looks like732 it is) unless it is a sum|multiply model which works properly. All733 others will need to be recalled from the model dropdown menu to reload734 the model into the calculation engine. While it might be annoying it735 does not appear to prevent SasView from working..722 inconsistently. If a change to a plugin model does not seem to 723 register, the Load Plugin Models (under fitting -> Plugin Model 724 Operations) can be used. However, after calling Load Plugin Models, the 725 active plugin will no longer be loaded (even though the GUI looks like 726 it is) unless it is a sum|multiply model which works properly. All 727 others will need to be recalled from the model dropdown menu to reload 728 the model into the calculation engine. While it might be annoying it 729 does not appear to prevent SasView from working.. 736 730 - The model code and documentation review is ongoing. At this time the 737 core shell parellelepiped is known to have the C shell effectively fixed738 at 0 (noted in documentation) while the triaxial ellipsoid does not seem739 to reproduce the limit of the oblate or prolate ellipsoid. If errors are740 found and corrected, corrected versions will be uploaded to the741 marketplace.742 731 core shell parellelepiped is known to have the C shell effectively fixed 732 at 0 (noted in documentation) while the triaxial ellipsoid does not seem 733 to reproduce the limit of the oblate or prolate ellipsoid. If errors are 734 found and corrected, corrected versions will be uploaded to the 735 marketplace. 736 743 737 3.1- All systems: 744 738 - The documentation window may take a few seconds to load the first time
Note: See TracChangeset
for help on using the changeset viewer.