Changes in installers/README.txt [beb6da4:16030b1] in sasview
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
installers/README.txt
rbeb6da4 r16030b1 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 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 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 16 19 to be supported (i.e. SasView will be able to run them) in 4.x. However, 17 20 the expectation is that such support will be removed in 5.0 and everyone 18 21 is strongly encouraged to convert their custom models to the new API. 19 Finally, the new orientation angles and orientatinal distribution is now 20 also complete. 21 22 23 Finally, the changes to orientation angles and orientational distribution 24 definitions are now also complete. 25 22 26 - Changes 23 27 - The infrastucture for calculating 2D patterns from 3D orientated objects … … 27 31 aligned objects has been completely overhauled. It now differs from 28 32 previous versions. 29 - Plugin models, including sum /multiply models, have completely migrated33 - Plugin models, including sum|multiply models, have completely migrated 30 34 to the new infrastructure. NOTE that 3.x type models as well as early, 31 35 intermediate 4.x type models, including those generated by sum|multiply … … 41 45 understanding the new orientation framework. 42 46 - Problems with the computation of magnetic scattering from some 43 objects have been rectified. Some questions however remain.47 objects have been rectified. Some questions remain however. 44 48 - The known issue with the core_shell_parallelepiped model is now fixed. 45 49 - A number of issues and inconsistencies with the creation of 46 sum| productmodels have been rectified.50 sum|multiply models have been rectified. 47 51 - A Boltzmann distribution has been added for polydispersity/orientational 48 52 distributions. … … 53 57 - There have been numerous other bug fixes. 54 58 - Documentation 55 Several sections of the help documentation have undergone significant59 Several sections of the help documentation have undergone significant 56 60 checking and updating, particularly those relating to orientation, 57 61 magnetic scattering, and polydispersity distributions. Detailed 58 62 advanced instructions for plugin writing and some scripting 59 63 instructions have been added. 64 Two new tutorials have been added. 60 65 - Other work 61 66 - A Third-Party initiative has recently succeeded in getting SasView to … … 75 80 Fixes # 467: Extend batch functionality to slicer 76 81 Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly 77 (USANS slit smearing)82 (USANS slit smearing) 78 83 Fixes # 499: create sin(x)/x, 2*J1(x)/x and 3*j1(x)/x functions 79 84 Fixes # 510: Build PDF documentation along with HTML … … 91 96 Fixes # 784: Add 3D integral to Correlation Function analysis 92 97 Fixes # 786: core_shell_parallelepiped 1-D model is incorrect 93 Fixes # 818: "report button" followed by "save"makes an empty pdf file98 Fixes # 818: ââ¬Åreport buttonââ¬ï¿œ followed by ââ¬Åsaveââ¬ï¿œ makes an empty pdf file 94 99 Fixes # 838: Fix model download from marketplace 95 100 Fixes # 848: can't save analysis when only one fit page … … 100 105 Fixes # 861: cannot defined a structure factor plugin 101 106 Fixes # 864: New Model Editor (simple plugin editor) error parsing 102 parameter line107 parameter line 103 108 Fixes # 865: Plugin live discovery issues 104 109 Fixes # 866: inform user when NaN is returned from compute … … 107 112 Fixes # 876: Add check for HDF5 format in dataloader 108 113 Fixes # 887: reorganize tree, separating the installed source from the 109 build source114 build source 110 115 Fixes # 889: Refactor dataloader error handling infrastructure 111 116 Fixes # 890: use new orientation definition for asymmetric shapes … … 126 131 Fixes # 930: fitting help says chisq is normalized to number of points 127 132 Fixes # 931: Allow admins to edit all models and upload data etc on 128 marketplace133 marketplace 129 134 Fixes # 932: Need to fix upload of data files to marketplace 130 135 Fixes # 934: Slurp tutorial repo for tutorials … … 133 138 Fixes # 950: Most of the readers don't close files properly. 134 139 Fixes # 954: cross check dll/opencl/python polydispersity and 135 orientation results140 orientation results 136 141 Fixes # 956: Possible problem with new doc build process 137 142 Fixes # 961: sasmodels tests should fail if the parameter name does not exist … … 144 149 Fixes # 983: Remove Nexus Loader 145 150 Fixes # 984: PDF reports are not being properly generated on Windows 146 Fixes # 985: Saving Project Fails 147 Fixes # 986: Send to fitting overwrites theory page even if blank 148 FitPage has focus151 Fixes # 985: Saving Project Fails 152 Fixes # 986: Send to fitting overwrites theory page even if blank 153 FitPage has focus 149 154 Fixes # 990: utest_sasview.py giving different results than run_one.py 150 155 Fixes # 993: Windows x64 versions not installing to correct folder … … 157 162 Fixes #1011: sld_test failing on ubuntu 158 163 Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded 159 multiple times164 multiple times 160 165 Fixes #1018: add Boltzmann distribution 161 166 Fixes #1021: add PDF documentation to website and document in wiki 162 release process167 release process 163 168 Fixes #1024: Update version numbers in master 164 169 Fixes #1025: Sum/multiply editor hangs … … 189 194 Fixes #1148: Documentation for S(Q) models need updating 190 195 Fixes #1128: AutoPlot generation for model documentation does not 191 include background196 include background 192 197 193 198 It is recommended that all users upgrade to this version, but your … … 199 204 have been made in the year since the previous release. Full release notes 200 205 will be compiled prior to the full release 4.2.0. 201 206 202 207 Highlights are: 203 208 - Infrastucture for calculating 2D patterns from 3D orientated objects 204 209 has now been totally refactored 205 - Plugins have completely migrated to the new infrastructure now, 206 210 - Plugins have completely migrated to the new infrastructure now, 211 including sum/multiply models 207 212 - Some batch slicing options have been introduced 208 213 - The known issue with the core_shell_parallelepiped is now fixed … … 211 216 - Numerous bug fixes 212 217 - Lots of documentation enhancement 213 218 214 219 In the meantime please report any bugs or issues found while using this beta 215 220 … … 242 247 This incremental release brings a series of new features and improvements, 243 248 and a host of bug fixes. Of particular note are: 244 249 245 250 - Correlation Function Analysis (Corfunc) 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 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 255 256 A volume fraction profile \Phi(z) describes how the density of polymer 257 258 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. 259 264 260 265 - Fitting of SESANS Data 261 Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will262 be plotted against the correct axes and models will automatically perform a Hankel 263 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. 264 269 265 270 - Documentation 266 271 The documentation has undergone significant checking and updating. 267 272 268 273 - Improvements … … 324 329 - Old custom models should now still work 325 330 - '''NOTE:''' These will be deprecated in a future version. Old 326 327 328 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. 329 334 - Custom model editor now creates new style models 330 335 - Custom model editor supports better error checking … … 337 342 - The active optimizer is now listed on the top of the fit panel. 338 343 - Linear fits now update qmin and max when the x scale limits are 339 344 changed. Also the plot range no longer resets after a fit. 340 345 - Bug fixes 341 346 - Fixes bug #511 Errors in linearized fits and clean up of interface 342 347 including Kratky representation 343 348 - Fixes bug #186 Data operation Tool now executes when something is 344 349 entered in the text box and does not wait for the user to hit enter 345 350 - Fixes bug #459 plot context menu bug 346 351 - Fixes bug #559 copy to clipboard in graph menu broken … … 642 647 ============================= 643 648 644 *** Note 1: The easiest approach to setting up the prop oer environment to649 *** Note 1: The easiest approach to setting up the proper environment to 645 650 build from source is to use conda. Instructions for setting up 646 using conda can be found at: 651 using conda can be found at: 647 652 http://trac.sasview.org/wiki/DevNotes/CondaDevSetup 648 653 *** Note 2: If you have EXE or ZIP SasView installer, you won't need any of … … 651 656 new version. 652 657 *** Note 3: Much more information is available at www.sasview.org under links. 653 658 Look in the 'For Developers' section and particularly the wiki at 654 659 www.sasview.org/trac/wiki. 655 660 … … 664 669 git clone https://github.com/Sasview/sasmodels.git 665 670 git clone https://github.com/bumps/bumps.git 671 - to install a specific version 666 672 667 673 - Build, install and run a specific release … … 683 689 changing the C model files 684 690 685 - 686 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 687 693 688 694 … … 703 709 issues: 704 710 - The way that orientation is defined is being refactored to address 705 706 707 708 709 710 711 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. 712 718 - The infrastructure currently handles internal conversion of old style 713 714 715 716 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. 717 723 - In that vein, the distributed models and those generated by the new 718 719 720 also disappear in the near future724 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 721 727 - The on the fly discovery of plugin models and changes thereto behave 722 723 724 725 726 727 728 729 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.. 730 736 - The model code and documentation review is ongoing. At this time the 731 732 733 734 735 marketplace.736 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 743 3.1- All systems: 738 744 - The documentation window may take a few seconds to load the first time
Note: See TracChangeset
for help on using the changeset viewer.