Changeset 7aab144 in sasview


Ignore:
Timestamp:
Sep 9, 2018 5:54:22 AM (2 months ago)
Author:
butler
Branches:
master, config-error, py37-all, py37-sascalc, py37-sasgui, pytest, simplify-c-build, ticket-1015-quick-fix, ticket-1094-headless, ticket-1111, ticket-1205-fit-weights, unittest-saveload
Children:
7e736c6
Parents:
711d7e7
Message:

Update 4.2.0 release notes

Location:
installers
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • installers/README-next-release.txt

    rfde3042 r7aab144  
    11Release Notes 
    22============= 
    3      
     3 
    441- Features 
    55=========== 
    66    - New in Version 4.2.0 
    77      -------------------- 
    8       This point release heralds many improvements and a host of bug fixes. But there are also some significant changes from previous versions. 
     8      This release heralds many improvements and a host of bug fixes, along with 
     9      some significant changes from previous versions. Further, as promised, it 
     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 
     16      to be supported (i.e. SasView will be able to run them) in 4.x. However, 
     17      the expectation is that such support will be removed in 5.0 and everyone 
     18      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. 
    921       
    1022      - Changes 
    11          - The infrastucture for calculating 2D patterns from 3D orientated objects has been totally re-factored. It is now more accurate and consistent across models. 
    12          - The way that SasView defines the orientation of anisometric and aligned objects has been completely overhauled. It now differs from previous versions. 
    13          - Plugin models, including sum/multiply models, have completely migrated to the new infrastructure. ???DO WE NEED TO SAY SOMETHING ABOUT BACKWARD COMPATIBILITY OR LEGACY SUPPORT HERE??? 
    14          - The NeXus loader has been removed (as it is superseded by the NXcanSAS loader). 
     23         - The infrastucture for calculating 2D patterns from 3D orientated objects 
     24           has been totally re-factored. It is now more accurate and consistent 
     25           across models. 
     26         - The way that SasView defines the orientation of anisometric and 
     27           aligned objects has been completely overhauled. It now differs from 
     28           previous versions. 
     29         - Plugin models, including sum/multiply models, have completely migrated 
     30           to the new infrastructure. NOTE that 3.x type models as well as early, 
     31           intermediate 4.x type models, including those generated by sum|multiply 
     32           will continue to be supported in 4.x but will likely no longer be 
     33           supported after the move to 5.0.  Users are strongly encouraged to 
     34           migrate any custom models. 
     35         - The NeXus loader has been removed as it is superseded by the NXcanSAS 
     36           standard loader and SasView does not support the treatment of raw 
     37           data. 
    1538      - Improvements 
    16          - The accuracy/speed of some numerical integrations have been improved. ???CHECK WITH PAULK??? 
    17          - An orientation viewer tool has been introduced (to assist in understanding the new orientation framework). 
    18          - Problems with the computation of magnetic scattering from some objects have been rectified. 
     39         - The accuracy/speed of some numerical integrations have been improved. 
     40         - An orientation viewer tool has been introduced to assist in 
     41           understanding the new orientation framework. 
     42         - Problems with the computation of magnetic scattering from some 
     43           objects have been rectified. Some questions however remain. 
    1944         - The known issue with the core_shell_parallelepiped model is now fixed. 
    20          - A number of issues and inconsistencies with the creation of sum|product models have been rectified (and more work is in progress). 
    21          - A Boltzmann distribution has been added for polydispersity/orientational distributions. 
     45         - A number of issues and inconsistencies with the creation of 
     46           sum|product models have been rectified. 
     47         - A Boltzmann distribution has been added for polydispersity/orientational 
     48           distributions. 
    2249         - Some batch slicing options have been introduced. 
    2350         - Correlation function analysis now computes both the 1D and 3D functions. 
    2451         - There are several data loading improvements. 
    25          - There are several improvements to Save/Load Project (with more to come). 
     52         - There are several improvements to Save/Load Project. 
    2653         - There have been numerous other bug fixes. 
    2754      - Documentation 
    28          Several sections of the help documentation have undergone significant checking and updating, particularly those relating to orientation, magnetic scattering, and polydispersity distributions. 
     55         Several sections of the help documentation have undergone significant 
     56           checking and updating, particularly those relating to orientation, 
     57           magnetic scattering, and polydispersity distributions. Detailed 
     58           advanced instructions for plugin writing and some scripting 
     59           instructions have been added. 
    2960      - Other work 
    30          - A Third-Party initiative has recently succeeded in getting SasView to run on Debian. More details at http://trac.sasview.org/wiki/DevNotes/Projects/Debian 
    31          - With this release we have started to prepare for the inevitable move to Python 3. 
    32          - SasView 5.0 is already in development. The two most significant features of this version will be (i) a move away from the present WxPython GUIs to new Qt5 GUIs, and (ii) implementation of the Beta-approximation for S(Q). Subject to resources, the latter functionality may be released (in a non-GUI form) in an interim SasView 4.3.0. 
     61         - A Third-Party initiative has recently succeeded in getting SasView to 
     62           run on Debian. More details at 
     63           http://trac.sasview.org/wiki/DevNotes/Projects/Debian 
     64         - With this release we have started to prepare for the inevitable move 
     65           to Python 3, which will occur with the release of 5.0 
     66         - SasView 5.0 is currently in development. The two most significant 
     67           features of this version will be (i) a move away from the present 
     68           WxPython GUIs to new, completely rewritten, Qt5 GUIs, and 
     69           (ii)implementation of the Beta-approximation for S(Q). Subject to 
     70           resources, some limited access to the latter functionality may be 
     71           available in a future SasView 4.x release. 
    3372      - Bug Fixes 
    34          Fixes #  14: Loading a saved project is really really slow   
    35          Fixes # 260: Box integration does not update when entering values in dialog   
    36          Fixes # 379: Need to make the BUMPS output page more more obvious   
    37          Fixes # 446: Saving plot as PGF (not PDF!) format throws error   
    38          Fixes # 467: Extend batch functionality to slicer   
    39          Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly (USANS slit smearing)   
    40          Fixes # 499: create sin(x)/x, 2*J1(x)/x and 3*j1(x)/x functions   
    41          Fixes # 510: Build PDF documentation along with HTML   
    42          Fixes # 525: Add GUI category defaults to models in sasmodels   
    43          Fixes # 579: clean up sasview directory   
    44          Fixes # 597: Need to document Combine Batch Fit   
    45          Fixes # 645: GUI logic problem in Batch vs single fit mode   
    46          Fixes # 648: Need to allow user input background value in Pr perspective   
    47          Fixes # 685: Fix data upload to marketplace   
    48          Fixes # 695: linear slope in onion model   
    49          Fixes # 735: Review new Corfunc documentation   
    50          Fixes # 741: Recalculate P(Q) and S(Q) components on model update.   
    51          Fixes # 767: Sum/Product Models don't do what they should   
    52          Fixes # 776: angular dispersity   
    53          Fixes # 784: Add 3D integral to Correlation Function analysis   
    54          Fixes # 786: core_shell_parallelepiped 1-D model is incorrect   
    55          Fixes # 818: “report button” followed by “save” makes an empty pdf file???   
    56          Fixes # 830: Check compliance of loader against NXcanSAS-1.0 release   
    57          Fixes # 838: Fix model download from marketplace   
    58          Fixes # 848: can't save analysis when only one fit page   
    59          Fixes # 849: Load Folder should ignore files starting with .   
    60          Fixes # 852: More unit tests, especially for oriented or 2d models   
    61          Fixes # 854: remove unnecessary sleep() in fitting perspective   
    62          Fixes # 856: Reading SAS_OPENCL from custom_config sometimes raises an ERROR   
    63          Fixes # 861: cannot defined a structure factor plugin   
    64          Fixes # 864: New Model Editor (simple plugin editor) error parsing parameter line   
    65          Fixes # 865: Plugin live discovery issues   
    66          Fixes # 866: inform user when NaN is returned from compute   
    67          Fixes # 869: fit page computation thread cleanup   
    68          Fixes # 875: Possible weirdness with 1D NXcanSAS data   
    69          Fixes # 876: Add check for HDF5 format in dataloader   
    70          Fixes # 887: reorganize tree, separating the installed source from the build source   
    71          Fixes # 889: Refactor dataloader error handling infrastructure   
    72          Fixes # 890: use new orientation definition for asymmetric shapes   
    73          Fixes # 891: update docs for oriented shapes with new orientation definition   
    74          Fixes # 896: equations in core shell parallelepiped docs do not match code   
    75          Fixes # 898: Image Viewer Tool file selector issue   
    76          Fixes # 899: Igor Reader q calculation   
    77          Fixes # 902: IgorReader Q calculation needs fixing/improving   
    78          Fixes # 903: sasview - all non-gui tests should be converted to run in Python 3   
    79          Fixes # 906: polydispersity not showing up in tabulated results   
    80          Fixes # 912: About box points to misleading contributors page on Github   
    81          Fixes # 913: Need to add Diamond developer and logo in relevant places   
    82          Fixes # 915: load project issues   
    83          Fixes # 916: Proper Logging   
    84          Fixes # 920: Logarithmic binning option in the slice viewer   
    85          Fixes # 921: Improve developer communication methods   
    86          Fixes # 922: Remove support for all data formats that are not in q space   
    87          Fixes # 923: Add CI and trac integrations to Slack   
    88          Fixes # 930: fitting help says chisq is normalized to number of points   
    89          Fixes # 931: Allow admins to edit all models and upload data etc on marketplace   
    90          Fixes # 932: Need to fix upload of data files to marketplace   
    91          Fixes # 934: Slurp tutorial repo for tutorials   
    92          Fixes # 935: Build new tutorials as PDF   
    93          Fixes # 943: Deep copy error on setting model after data is selected   
    94          Fixes # 950: Most of the readers don't close files properly.   
    95          Fixes # 954: cross check dll/opencl/python polydispersity and orientation results   
    96          Fixes # 956: Possible problem with new doc build process   
    97          Fixes # 961: sasmodels tests should fail if the parameter name does not exist   
    98          Fixes # 962: star polymer typo in docs   
    99          Fixes # 966: Inconsistent chi2 reporting   
    100          Fixes # 967: no uncertainties errors on fitting parameters   
    101          Fixes # 969: About Box not picking up dls_logo.png   
    102          Fixes # 970: ASCII loader doesn't handle ISIS 2D ASCII   
    103          Fixes # 974: blacklist Intel HD 620/630 for double precision   
    104          Fixes # 978: load project fails for pages which have not been defined   
    105          Fixes # 980: Inconsistent results between Igor & SasView using Fractal Core-Shell model   
    106          Fixes # 983: Remove Nexus Loader   
    107          Fixes # 984: PDF reports are not being properly generated on Windows   
     73         Fixes # 260: Box integration does not update when entering values in dialog 
     74         Fixes # 446: Saving plot as PGF (not PDF!) format throws error 
     75         Fixes # 467: Extend batch functionality to slicer 
     76         Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly 
     77           (USANS slit smearing) 
     78         Fixes # 499: create sin(x)/x, 2*J1(x)/x and 3*j1(x)/x functions 
     79         Fixes # 510: Build PDF documentation along with HTML 
     80         Fixes # 525: Add GUI category defaults to models in sasmodels 
     81         Fixes # 579: clean up sasview directory 
     82         Fixes # 597: Need to document Combine Batch Fit 
     83         Fixes # 645: GUI logic problem in Batch vs single fit mode 
     84         Fixes # 648: Need to allow user input background value in Pr perspective 
     85         Fixes # 685: Fix data upload to marketplace 
     86         Fixes # 695: linear slope in onion model 
     87         Fixes # 735: Review new Corfunc documentation 
     88         Fixes # 741: Recalculate P(Q) and S(Q) components on model update. 
     89         Fixes # 767: Sum/Product Models don't do what they should 
     90         Fixes # 776: angular dispersity 
     91         Fixes # 784: Add 3D integral to Correlation Function analysis 
     92         Fixes # 786: core_shell_parallelepiped 1-D model is incorrect 
     93         Fixes # 818: “report button” followed by “save” makes an empty pdf file 
     94         Fixes # 838: Fix model download from marketplace 
     95         Fixes # 848: can't save analysis when only one fit page 
     96         Fixes # 849: Load Folder should ignore files starting with . 
     97         Fixes # 852: More unit tests, especially for oriented or 2d models 
     98         Fixes # 854: remove unnecessary sleep() in fitting perspective 
     99         Fixes # 856: Reading SAS_OPENCL from custom_config sometimes raises an ERROR 
     100         Fixes # 861: cannot defined a structure factor plugin 
     101         Fixes # 864: New Model Editor (simple plugin editor) error parsing 
     102           parameter line 
     103         Fixes # 865: Plugin live discovery issues 
     104         Fixes # 866: inform user when NaN is returned from compute 
     105         Fixes # 869: fit page computation thread cleanup 
     106         Fixes # 875: Possible weirdness with 1D NXcanSAS data 
     107         Fixes # 876: Add check for HDF5 format in dataloader 
     108         Fixes # 887: reorganize tree, separating the installed source from the 
     109           build source 
     110         Fixes # 889: Refactor dataloader error handling infrastructure 
     111         Fixes # 890: use new orientation definition for asymmetric shapes 
     112         Fixes # 891: update docs for oriented shapes with new orientation definition 
     113         Fixes # 896: equations in core shell parallelepiped docs do not match code 
     114         Fixes # 898: Image Viewer Tool file selector issue 
     115         Fixes # 899: Igor Reader q calculation 
     116         Fixes # 902: IgorReader Q calculation needs fixing/improving 
     117         Fixes # 903: sasview - all non-gui tests should be converted to run in Python 3 
     118         Fixes # 906: polydispersity not showing up in tabulated results 
     119         Fixes # 912: About box points to misleading contributors page on Github 
     120         Fixes # 915: load project issues 
     121         Fixes # 916: Proper Logging 
     122         Fixes # 920: Logarithmic binning option in the slice viewer 
     123         Fixes # 921: Improve developer communication methods 
     124         Fixes # 922: Remove support for all data formats that are not in q space 
     125         Fixes # 923: Add CI and trac integrations to Slack 
     126         Fixes # 930: fitting help says chisq is normalized to number of points 
     127         Fixes # 931: Allow admins to edit all models and upload data etc on 
     128           marketplace 
     129         Fixes # 932: Need to fix upload of data files to marketplace 
     130         Fixes # 934: Slurp tutorial repo for tutorials 
     131         Fixes # 935: Build new tutorials as PDF 
     132         Fixes # 943: Deep copy error on setting model after data is selected 
     133         Fixes # 950: Most of the readers don't close files properly. 
     134         Fixes # 954: cross check dll/opencl/python polydispersity and 
     135           orientation results 
     136         Fixes # 956: Possible problem with new doc build process 
     137         Fixes # 961: sasmodels tests should fail if the parameter name does not exist 
     138         Fixes # 962: star polymer typo in docs 
     139         Fixes # 967: no uncertainties errors on fitting parameters 
     140         Fixes # 969: About Box not picking up dls_logo.png 
     141         Fixes # 970: ASCII loader doesn't handle ISIS 2D ASCII 
     142         Fixes # 974: blacklist Intel HD 620/630 for double precision 
     143         Fixes # 978: load project fails for pages which have not been defined 
     144         Fixes # 983: Remove Nexus Loader 
     145         Fixes # 984: PDF reports are not being properly generated on Windows 
    108146         Fixes # 985: Saving Project Fails   
    109          Fixes # 986: Send to fitting overwrites theory page even if blank FitPage has focus   
    110          Fixes # 990: utest_sasview.py giving different results than run_one.py   
    111          Fixes # 993: Windows x64 versions not installing to correct folder   
    112          Fixes # 994: Error changing fit engine   
    113          Fixes # 995: OpenCL required on Linux even if turned off in GUI   
    114          Fixes #1006: multiplicity models don't work with SQ   
    115          Fixes #1007: spherical_sld model freezes SasView   
    116          Fixes #1008: plugin model scaling not working? S  
    117          Fixes #1010: Win64 build script not creating working executable   
    118          Fixes #1011: sld_test failing on ubuntu   
    119          Fixes #1012: ESS GUI not updating after fitting   
    120          Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded multiple times   
    121          Fixes #1018: add Boltzmann distribution   
    122          Fixes #1021: add PDF documentation to website and document in wiki release process   
    123          Fixes #1024: Update version numbers in master   
    124          Fixes #1025: Sum/multiply editor hangs   
    125          Fixes #1032: convert C++ modules to C   
    126          Fixes #1035: Order of combining P(Q) and S(Q) in Plugins seems to matter   
    127          Fixes #1037: data loader crop not working? & all fits crashing   
    128          Fixes #1043: problem compiling marketplace models   
    129          Fixes #1050: fix appveyor test for sasmodels win 64 python 3   
    130          Fixes #1052: Can't use a user-created plugin model in a plugin model   
    131          Fixes #1054: Check plugin & orientation descriptions in full docs once SasModels PR #57 is merged   
    132          Fixes #1057: phi rotation issue for elliptical cylinder   
    133          Fixes #1060: incorrect default for rectangle dispersion   
    134          Fixes #1062: win32 build not installing correctly   
    135          Fixes #1064: Fitting did not converge!!! error with a Sum|Multi plugin model   
    136          Fixes #1068: 2d data (from NG7) not loadiing - strange format?   
    137          Fixes #1069: GUI problem when using polydispersity/orientation distributions   
    138          Fixes #1070: Parameter error boxes should not be editable   
    139          Fixes #1072: Orientation distributions seem to depend on initial angle   
    140          Fixes #1079: Remove save button in report dialog on Mac   
    141          Fixes #1081: GUI problem with new orientation distribution   
    142          Fixes #1083: Magnetic models not being computed   
    143          Fixes #1099: Erratic behaviour of Sum|Multi model in 4.1.2   
    144          Fixes #1101: Batch results page not displaying polydispersity values   
    145          Fixes #1103: Problem with plugin models on mac when using ER   
    146          Fixes #1134: sum/multi scale factor in 4.2 seems incorrect?   
    147          Fixes #1139: Missing Docs and Help for new Batch Slicing   
    148          Fixes #1145: Update models in model marketplace to 4.2 when 4.2 is released.   
    149          Fixes #1146: Need to add Release notes for 4.2  
    150       - Current Known Issues 
    151          Listed here are known issues that users should be aware of. A full list of known bugs and feature requests is available at http://trac.sasview.org/report/3 
    152       - Blocker 
    153          Ticket #1131: OpencCl dialog does not open                                              assigned wojciech defect blocker 
    154          Ticket #1132: Slit Size Calculator Tool not working                                     assigned krzywon defect blocker 
    155          Ticket #1133: Reference in Acknowledging SasView box will need updating for release     assigned ajj task blocker 
    156          Ticket #1142: Plugin framework is broken                                                reopened pkienzle defect blocker 
    157       - Critical 
    158          Ticket #1148: Documentation for S(Q) models need updating SasView 4.2.0                 assigned butler defect critical 
    159       - Other Significant 
    160          Ticket #1046: convert non builtin models in the marketplace to new API                  assigned butler task major 
    161          Ticket #1128: AutoPlot generation for model documentation does not include background   assigned pkienzle defect major 
    162          Ticket #1140: Batch Slicer requires plotting of all 2D data sets to use in batch        assigned krzywon enhancement major 
    163          Ticket #1141: Intro to scripting.rst needs improvement                                  new pkienzle enhancement major 
    164          Ticket #1143: Validate new orientation distribution                                     assigned butler task major 
    165          Ticket #1144: Redundant MultiplicationModel class                                       new pkienzle defect major 
    166       - Model Issues 
    167          Corrections will be posted to Marketplace as available (and fixed in following release) 
    168          Ticket #1044: Unable to upload c file to marketplace                                    assigned tim defect major 
    169  
    170       It is recommended that all users upgrade to this version, but your attention is drawn to the Changes section above. 
     147         Fixes # 986: Send to fitting overwrites theory page even if blank  
     148           FitPage has focus 
     149         Fixes # 990: utest_sasview.py giving different results than run_one.py 
     150         Fixes # 993: Windows x64 versions not installing to correct folder 
     151         Fixes # 994: Error changing fit engine 
     152         Fixes # 995: OpenCL required on Linux even if turned off in GUI 
     153         Fixes #1006: multiplicity models don't work with SQ 
     154         Fixes #1007: spherical_sld model freezes SasView 
     155         Fixes #1008: plugin model scaling not working? S 
     156         Fixes #1010: Win64 build script not creating working executable 
     157         Fixes #1011: sld_test failing on ubuntu 
     158         Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded 
     159           multiple times 
     160         Fixes #1018: add Boltzmann distribution 
     161         Fixes #1021: add PDF documentation to website and document in wiki 
     162           release process 
     163         Fixes #1024: Update version numbers in master 
     164         Fixes #1025: Sum/multiply editor hangs 
     165         Fixes #1032: convert C++ modules to C 
     166         Fixes #1035: Order of combining P(Q) and S(Q) in Plugins seems to matter 
     167         Fixes #1037: data loader crop not working? & all fits crashing 
     168         Fixes #1043: problem compiling marketplace models 
     169         Fixes #1050: fix appveyor test for sasmodels win 64 python 3 
     170         Fixes #1052: Can't use a user-created plugin model in a plugin model 
     171         Fixes #1057: phi rotation issue for elliptical cylinder 
     172         Fixes #1060: incorrect default for rectangle dispersion 
     173         Fixes #1062: win32 build not installing correctly 
     174         Fixes #1064: Fitting did not converge!!! error with a Sum|Multi plugin model 
     175         Fixes #1069: GUI problem when using polydispersity/orientation distributions 
     176         Fixes #1070: Parameter error boxes should not be editable 
     177         Fixes #1079: Remove save button in report dialog on Mac 
     178         Fixes #1081: GUI problem with new orientation distribution 
     179         Fixes #1083: Magnetic models not being computed 
     180         Fixes #1099: Erratic behaviour of Sum|Multi model in 4.1.2 
     181         Fixes #1101: Batch results page not displaying polydispersity values 
     182         Fixes #1131: OpencCl dialog does not open 
     183         Fixes #1132: Slit Size Calculator Tool not working 
     184         Fixes #1139: Missing Docs and Help for new Batch Slicing 
     185         Fixes #1141: Intro to scripting.rst needs improvement 
     186         Fixes #1142: Plugin framework is broken 
     187         Fixes #1044: Unable to upload c file to marketplace 
     188         Fixes #1145: Update models in model marketplace to 4.2 when 4.2 is released. 
     189         Fixes #1148: Documentation for S(Q) models need updating 
     190         Fixes #1128: AutoPlot generation for model documentation does not 
     191           include background 
     192 
     193      It is recommended that all users upgrade to this version, but your 
     194      attention is drawn to the Changes section above. 
     195 
     196    - New in Version 4.2.0-Beta 
     197      ------------------------- 
     198      This is a beta pre-release version of 4.2.0.  A number of fixes and changes 
     199      have been made in the year since the previous release. Full release notes 
     200      will be compiled prior to the full release 4.2.0. 
     201     
     202      Highlights are: 
     203        - Infrastucture for calculating 2D patterns from 3D orientated objects 
     204          has now been totally refactored 
     205        - Plugins have completely migrated to the new infrastructure now,  
     206              including sum/multiply models 
     207        - Some batch slicing options have been introduced 
     208        - The known issue with the core_shell_parallelepiped is now fixed 
     209        - Several data loading improvements 
     210        - Several save Project improvements (though there are more to come) 
     211        - Numerous bug fixes 
     212        - Lots of documentation enhancement 
     213     
     214      In the meantime please report any bugs or issues found while using this beta 
    171215 
    172216 
     
    180224 
    181225      It is recommended that all users upgrade to this version 
    182  
    183226 
    184227    - New in Version 4.1.1 
     
    195238       - Updated tutorials for SasView 4.x.y 
    196239 
    197  
    198240    - New in Version 4.1.0 
    199241      ------------------ 
     
    203245      - Correlation Function Analysis (Corfunc) 
    204246        This performs a correlation function analysis of one-dimensional SAXS/SANS data,  
    205             or generates a model-independent volume fraction profile from the SANS from an  
    206             adsorbed polymer/surfactant layer. 
    207  
    208             A correlation function may be interpreted in terms of an imaginary rod moving  
    209             through the structure of the material. Γ1D(R) is the probability that a rod of  
    210             length R moving through the material has equal electron/neutron scattering  
    211             length density at either end. Hence a frequently occurring spacing within a  
    212             structure manifests itself as a peak. 
    213  
    214             A volume fraction profile \Phi(z) describes how the density of polymer  
    215             segments/surfactant molecules varies with distance from an (assumed locally flat) 
    216             interface. 
     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. Γ1D(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. 
    217259 
    218260      - Fitting of SESANS Data 
    219261        Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will  
    220             be plotted against the correct axes and models will automatically perform a Hankel  
    221             transform in order to calculate SESANS from a SANS model. 
     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. 
    222264 
    223265      - Documentation 
     
    305347         - Fixes bug #466 cannot remove a linear fit from graph 
    306348         - Numerous bugs introduced in the alpha 
     349 
    307350 
    308351 
     
    343386 
    344387 
     388 
    345389   - New in Version 3.1.2 
    346390     -------------------- 
     
    360404 
    361405 
     406 
    362407   - New in Version 3.1.1 
    363408     -------------------- 
    364409     - Fixes bug #457 that prevented SasView from starting if the user was not 
    365410       connected to the internet, or was behind a proxy server. 
    366  
    367411 
    368412   - New in Version 3.1.0 
     
    421465       non-project personnel through pull requests. 
    422466 
    423  
    424467   - New in Version 3.0.0 
    425468     -------------------- 
     
    452495         data. Supported formats include: TIFF, TIF, PNG, BMP, JPG. 
    453496 
    454  
    455497   - New in Version 2.2.1 
    456498     -------------------- 
     
    464506     - Made significant improvements to the batch/grid panel and fixed several bugs 
    465507     - Fixed a number of other minor bugs 
    466  
    467508 
    468509   - New in Version 2.2.0 
     
    601642============================= 
    602643 
    603    *** Note 1:  Much more information is available at www.sasview.org under links. 
    604                     Look in the 'For Developers' section and particularly the wiki at 
    605                 www.sasview.org/trac/wiki. 
     644   *** Note 1:  The easiest approach to setting up the propoer environment to 
     645                build from source is to use conda.  Instructions for setting up 
     646                using conda can be found at:  
     647                http://trac.sasview.org/wiki/DevNotes/CondaDevSetup 
    606648   *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of 
    607649                the following.  However it is highly recommended that any 
    608650                previous versions be un-installed prior to installing the 
    609651                new version. 
     652   *** Note 3:  Much more information is available at www.sasview.org under links. 
     653                    Look in the 'For Developers' section and particularly the wiki at 
     654                www.sasview.org/trac/wiki. 
    610655 
    611656   2.1- System Requirements 
     
    617662          - to follow the current development version from source control use 
    618663              git clone https://github.com/SasView/sasview.git 
     664              git clone https://github.com/Sasview/sasmodels.git 
    619665              git clone https://github.com/bumps/bumps.git 
    620666          - to install a specific version 
     
    630676          - clone the source from git; also clone bumps, which is developed in parallel 
    631677              git clone https://github.com/SasView/sasview.git 
     678              git clone https://github.com/Sasview/sasmodels.git 
    632679              git clone https://github.com/bumps/bumps.git 
    633680          - open a command line window in the 'sasview' directory 
     
    635682          - run 'python run.py'; this runs from the source directories, so you 
    636683            don't have to rebuild every time you make a change, unless you are 
    637             changing the C++ model files 
    638  
    639         - The following modules are required (version numbers are what are used 
    640           in the windows release build): 
    641  
    642           - Common Packages 
    643             - reportlab 3.1.44 
    644             - lxml 3.4.4.0 (MAC 3.4.2.0) 
    645             - PIL 1.1.7 
    646             - xhtml2pdf 3.0.33 (MAC = not installed on build server) 
    647             - unittest-xml-reporting 1.12.0 (MAC 1.10.0) 
    648             - matplotlib Version Installed: 1.4.3 (MAC 1.1.1) 
    649             - bumps Version Installed: 0.7.5.9 
    650             - scipy Version Installed: 0.16.0b2 (MAC 0.11.0) 
    651             - periodictable Version Installed: 1.4.1 
    652             - setuptools Version Installed: 7.0 (MAC 12.0.5) 
    653             - sphinx Version Installed: 1.3.1 (MAC 1.3b2) 
    654             - pyparsing Version Installed: 2.0.3 
    655             - numpy Version Installed: 1.9.2 (MAC 1.6.2) 
    656             - html5lib Version Installed: 0.99999 
    657             - wx Version Installed: 3.0.2.0 
    658  
    659           - Windows Specific Packages 
    660             - pywin 219 
    661             - py2exe 0.6.9 
    662             - comtypes 1.1.1 
    663             - MinGW w/ gcc version 4.6.1 (WIN) 
    664             - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008 
    665               re-distributable) 
    666             - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable 
    667  
    668             *** Note: Windows build dependencies can be set up using anaconda. Instructions 
    669                 can be found at http://trac.sasview.org/wiki/AnacondaSetup 
    670  
    671           - MAC Specifc Packages 
    672             - py2app 0.7.1 
     684            changing the C model files 
     685 
     686        -For the latest list of dependencies see the appropriate yml file in 
     687          the SasView repo at sasview/build_tools/conda/ymls  
    673688 
    674689 
    6756903- Known Issues 
    676691=============== 
     692 
     693 
     694   4.2.0 - All systmes 
     695      There are currently no major known issues. A full list of known bugs and 
     696      feature requests by release version that users may wish to be aware of 
     697      can be viewed at http://trac.sasview.org/report/3 
     698      NOTE: Any corrections to models that may become known/available will be 
     699      posted to Marketplace as available (and fixed in the following release) 
    677700 
    678701   4.1- All systems: 
  • installers/README.txt

    r2b07b6d r7aab144  
    11Release Notes 
    22============= 
    3     This is a beta pre-release version of 4.2.0.  A number of fixes and changes 
    4     have been made in the year since the previous release.   
    5     Full release notes will be compiled prior to the full release 4.2.0. 
     3 
     41- Features 
     5=========== 
     6    - New in Version 4.2.0 
     7      -------------------- 
     8      This release heralds many improvements and a host of bug fixes, along with 
     9      some significant changes from previous versions. Further, as promised, it 
     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 
     16      to be supported (i.e. SasView will be able to run them) in 4.x. However, 
     17      the expectation is that such support will be removed in 5.0 and everyone 
     18      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      - Changes 
     23         - The infrastucture for calculating 2D patterns from 3D orientated objects 
     24           has been totally re-factored. It is now more accurate and consistent 
     25           across models. 
     26         - The way that SasView defines the orientation of anisometric and 
     27           aligned objects has been completely overhauled. It now differs from 
     28           previous versions. 
     29         - Plugin models, including sum/multiply models, have completely migrated 
     30           to the new infrastructure. NOTE that 3.x type models as well as early, 
     31           intermediate 4.x type models, including those generated by sum|multiply 
     32           will continue to be supported in 4.x but will likely no longer be 
     33           supported after the move to 5.0.  Users are strongly encouraged to 
     34           migrate any custom models. 
     35         - The NeXus loader has been removed as it is superseded by the NXcanSAS 
     36           standard loader and SasView does not support the treatment of raw 
     37           data. 
     38      - Improvements 
     39         - The accuracy/speed of some numerical integrations have been improved. 
     40         - An orientation viewer tool has been introduced to assist in 
     41           understanding the new orientation framework. 
     42         - Problems with the computation of magnetic scattering from some 
     43           objects have been rectified. Some questions however remain. 
     44         - The known issue with the core_shell_parallelepiped model is now fixed. 
     45         - A number of issues and inconsistencies with the creation of 
     46           sum|product models have been rectified. 
     47         - A Boltzmann distribution has been added for polydispersity/orientational 
     48           distributions. 
     49         - Some batch slicing options have been introduced. 
     50         - Correlation function analysis now computes both the 1D and 3D functions. 
     51         - There are several data loading improvements. 
     52         - There are several improvements to Save/Load Project. 
     53         - There have been numerous other bug fixes. 
     54      - Documentation 
     55         Several sections of the help documentation have undergone significant 
     56           checking and updating, particularly those relating to orientation, 
     57           magnetic scattering, and polydispersity distributions. Detailed 
     58           advanced instructions for plugin writing and some scripting 
     59           instructions have been added. 
     60      - Other work 
     61         - A Third-Party initiative has recently succeeded in getting SasView to 
     62           run on Debian. More details at 
     63           http://trac.sasview.org/wiki/DevNotes/Projects/Debian 
     64         - With this release we have started to prepare for the inevitable move 
     65           to Python 3, which will occur with the release of 5.0 
     66         - SasView 5.0 is currently in development. The two most significant 
     67           features of this version will be (i) a move away from the present 
     68           WxPython GUIs to new, completely rewritten, Qt5 GUIs, and 
     69           (ii)implementation of the Beta-approximation for S(Q). Subject to 
     70           resources, some limited access to the latter functionality may be 
     71           available in a future SasView 4.x release. 
     72      - Bug Fixes 
     73         Fixes # 260: Box integration does not update when entering values in dialog 
     74         Fixes # 446: Saving plot as PGF (not PDF!) format throws error 
     75         Fixes # 467: Extend batch functionality to slicer 
     76         Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly 
     77           (USANS slit smearing) 
     78         Fixes # 499: create sin(x)/x, 2*J1(x)/x and 3*j1(x)/x functions 
     79         Fixes # 510: Build PDF documentation along with HTML 
     80         Fixes # 525: Add GUI category defaults to models in sasmodels 
     81         Fixes # 579: clean up sasview directory 
     82         Fixes # 597: Need to document Combine Batch Fit 
     83         Fixes # 645: GUI logic problem in Batch vs single fit mode 
     84         Fixes # 648: Need to allow user input background value in Pr perspective 
     85         Fixes # 685: Fix data upload to marketplace 
     86         Fixes # 695: linear slope in onion model 
     87         Fixes # 735: Review new Corfunc documentation 
     88         Fixes # 741: Recalculate P(Q) and S(Q) components on model update. 
     89         Fixes # 767: Sum/Product Models don't do what they should 
     90         Fixes # 776: angular dispersity 
     91         Fixes # 784: Add 3D integral to Correlation Function analysis 
     92         Fixes # 786: core_shell_parallelepiped 1-D model is incorrect 
     93         Fixes # 818: “report button” followed by “save” makes an empty pdf file 
     94         Fixes # 838: Fix model download from marketplace 
     95         Fixes # 848: can't save analysis when only one fit page 
     96         Fixes # 849: Load Folder should ignore files starting with . 
     97         Fixes # 852: More unit tests, especially for oriented or 2d models 
     98         Fixes # 854: remove unnecessary sleep() in fitting perspective 
     99         Fixes # 856: Reading SAS_OPENCL from custom_config sometimes raises an ERROR 
     100         Fixes # 861: cannot defined a structure factor plugin 
     101         Fixes # 864: New Model Editor (simple plugin editor) error parsing 
     102           parameter line 
     103         Fixes # 865: Plugin live discovery issues 
     104         Fixes # 866: inform user when NaN is returned from compute 
     105         Fixes # 869: fit page computation thread cleanup 
     106         Fixes # 875: Possible weirdness with 1D NXcanSAS data 
     107         Fixes # 876: Add check for HDF5 format in dataloader 
     108         Fixes # 887: reorganize tree, separating the installed source from the 
     109           build source 
     110         Fixes # 889: Refactor dataloader error handling infrastructure 
     111         Fixes # 890: use new orientation definition for asymmetric shapes 
     112         Fixes # 891: update docs for oriented shapes with new orientation definition 
     113         Fixes # 896: equations in core shell parallelepiped docs do not match code 
     114         Fixes # 898: Image Viewer Tool file selector issue 
     115         Fixes # 899: Igor Reader q calculation 
     116         Fixes # 902: IgorReader Q calculation needs fixing/improving 
     117         Fixes # 903: sasview - all non-gui tests should be converted to run in Python 3 
     118         Fixes # 906: polydispersity not showing up in tabulated results 
     119         Fixes # 912: About box points to misleading contributors page on Github 
     120         Fixes # 915: load project issues 
     121         Fixes # 916: Proper Logging 
     122         Fixes # 920: Logarithmic binning option in the slice viewer 
     123         Fixes # 921: Improve developer communication methods 
     124         Fixes # 922: Remove support for all data formats that are not in q space 
     125         Fixes # 923: Add CI and trac integrations to Slack 
     126         Fixes # 930: fitting help says chisq is normalized to number of points 
     127         Fixes # 931: Allow admins to edit all models and upload data etc on 
     128           marketplace 
     129         Fixes # 932: Need to fix upload of data files to marketplace 
     130         Fixes # 934: Slurp tutorial repo for tutorials 
     131         Fixes # 935: Build new tutorials as PDF 
     132         Fixes # 943: Deep copy error on setting model after data is selected 
     133         Fixes # 950: Most of the readers don't close files properly. 
     134         Fixes # 954: cross check dll/opencl/python polydispersity and 
     135           orientation results 
     136         Fixes # 956: Possible problem with new doc build process 
     137         Fixes # 961: sasmodels tests should fail if the parameter name does not exist 
     138         Fixes # 962: star polymer typo in docs 
     139         Fixes # 967: no uncertainties errors on fitting parameters 
     140         Fixes # 969: About Box not picking up dls_logo.png 
     141         Fixes # 970: ASCII loader doesn't handle ISIS 2D ASCII 
     142         Fixes # 974: blacklist Intel HD 620/630 for double precision 
     143         Fixes # 978: load project fails for pages which have not been defined 
     144         Fixes # 983: Remove Nexus Loader 
     145         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 focus 
     149         Fixes # 990: utest_sasview.py giving different results than run_one.py 
     150         Fixes # 993: Windows x64 versions not installing to correct folder 
     151         Fixes # 994: Error changing fit engine 
     152         Fixes # 995: OpenCL required on Linux even if turned off in GUI 
     153         Fixes #1006: multiplicity models don't work with SQ 
     154         Fixes #1007: spherical_sld model freezes SasView 
     155         Fixes #1008: plugin model scaling not working? S 
     156         Fixes #1010: Win64 build script not creating working executable 
     157         Fixes #1011: sld_test failing on ubuntu 
     158         Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded 
     159           multiple times 
     160         Fixes #1018: add Boltzmann distribution 
     161         Fixes #1021: add PDF documentation to website and document in wiki 
     162           release process 
     163         Fixes #1024: Update version numbers in master 
     164         Fixes #1025: Sum/multiply editor hangs 
     165         Fixes #1032: convert C++ modules to C 
     166         Fixes #1035: Order of combining P(Q) and S(Q) in Plugins seems to matter 
     167         Fixes #1037: data loader crop not working? & all fits crashing 
     168         Fixes #1043: problem compiling marketplace models 
     169         Fixes #1050: fix appveyor test for sasmodels win 64 python 3 
     170         Fixes #1052: Can't use a user-created plugin model in a plugin model 
     171         Fixes #1057: phi rotation issue for elliptical cylinder 
     172         Fixes #1060: incorrect default for rectangle dispersion 
     173         Fixes #1062: win32 build not installing correctly 
     174         Fixes #1064: Fitting did not converge!!! error with a Sum|Multi plugin model 
     175         Fixes #1069: GUI problem when using polydispersity/orientation distributions 
     176         Fixes #1070: Parameter error boxes should not be editable 
     177         Fixes #1079: Remove save button in report dialog on Mac 
     178         Fixes #1081: GUI problem with new orientation distribution 
     179         Fixes #1083: Magnetic models not being computed 
     180         Fixes #1099: Erratic behaviour of Sum|Multi model in 4.1.2 
     181         Fixes #1101: Batch results page not displaying polydispersity values 
     182         Fixes #1131: OpencCl dialog does not open 
     183         Fixes #1132: Slit Size Calculator Tool not working 
     184         Fixes #1139: Missing Docs and Help for new Batch Slicing 
     185         Fixes #1141: Intro to scripting.rst needs improvement 
     186         Fixes #1142: Plugin framework is broken 
     187         Fixes #1044: Unable to upload c file to marketplace 
     188         Fixes #1145: Update models in model marketplace to 4.2 when 4.2 is released. 
     189         Fixes #1148: Documentation for S(Q) models need updating 
     190         Fixes #1128: AutoPlot generation for model documentation does not 
     191           include background 
     192 
     193      It is recommended that all users upgrade to this version, but your 
     194      attention is drawn to the Changes section above. 
     195 
     196    - New in Version 4.2.0-Beta 
     197      ------------------------- 
     198      This is a beta pre-release version of 4.2.0.  A number of fixes and changes 
     199      have been made in the year since the previous release. Full release notes 
     200      will be compiled prior to the full release 4.2.0. 
    6201     
    7     Highlights are: 
     202      Highlights are: 
    8203        - Infrastucture for calculating 2D patterns from 3D orientated objects 
    9204          has now been totally refactored 
    10205        - Plugins have completely migrated to the new infrastructure now,  
    11           including sum/multiply models 
     206              including sum/multiply models 
    12207        - Some batch slicing options have been introduced 
    13208        - The known issue with the core_shell_parallelepiped is now fixed 
     
    17212        - Lots of documentation enhancement 
    18213     
    19     In the meantime please report any bugs or issues found while using this beta 
    20      
    21 1- Features 
    22 =========== 
     214      In the meantime please report any bugs or issues found while using this beta 
     215 
     216 
    23217    - New in Version 4.1.2 
    24218      -------------------- 
     
    448642============================= 
    449643 
    450    *** Note 1:  Much more information is available at www.sasview.org under links. 
    451                     Look in the 'For Developers' section and particularly the wiki at 
    452                 www.sasview.org/trac/wiki. 
     644   *** Note 1:  The easiest approach to setting up the propoer environment to 
     645                build from source is to use conda.  Instructions for setting up 
     646                using conda can be found at:  
     647                http://trac.sasview.org/wiki/DevNotes/CondaDevSetup 
    453648   *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of 
    454649                the following.  However it is highly recommended that any 
    455650                previous versions be un-installed prior to installing the 
    456651                new version. 
     652   *** Note 3:  Much more information is available at www.sasview.org under links. 
     653                    Look in the 'For Developers' section and particularly the wiki at 
     654                www.sasview.org/trac/wiki. 
    457655 
    458656   2.1- System Requirements 
     
    464662          - to follow the current development version from source control use 
    465663              git clone https://github.com/SasView/sasview.git 
     664              git clone https://github.com/Sasview/sasmodels.git 
    466665              git clone https://github.com/bumps/bumps.git 
    467666          - to install a specific version 
     
    477676          - clone the source from git; also clone bumps, which is developed in parallel 
    478677              git clone https://github.com/SasView/sasview.git 
     678              git clone https://github.com/Sasview/sasmodels.git 
    479679              git clone https://github.com/bumps/bumps.git 
    480680          - open a command line window in the 'sasview' directory 
     
    482682          - run 'python run.py'; this runs from the source directories, so you 
    483683            don't have to rebuild every time you make a change, unless you are 
    484             changing the C++ model files 
    485  
    486         - The following modules are required (version numbers are what are used 
    487           in the windows release build): 
    488  
    489           - Common Packages 
    490             - reportlab 3.1.44 
    491             - lxml 3.4.4.0 (MAC 3.4.2.0) 
    492             - PIL 1.1.7 
    493             - xhtml2pdf 3.0.33 (MAC = not installed on build server) 
    494             - unittest-xml-reporting 1.12.0 (MAC 1.10.0) 
    495             - matplotlib Version Installed: 1.4.3 (MAC 1.1.1) 
    496             - bumps Version Installed: 0.7.5.9 
    497             - scipy Version Installed: 0.16.0b2 (MAC 0.11.0) 
    498             - periodictable Version Installed: 1.4.1 
    499             - setuptools Version Installed: 7.0 (MAC 12.0.5) 
    500             - sphinx Version Installed: 1.3.1 (MAC 1.3b2) 
    501             - pyparsing Version Installed: 2.0.3 
    502             - numpy Version Installed: 1.9.2 (MAC 1.6.2) 
    503             - html5lib Version Installed: 0.99999 
    504             - wx Version Installed: 3.0.2.0 
    505  
    506           - Windows Specific Packages 
    507             - pywin 219 
    508             - py2exe 0.6.9 
    509             - comtypes 1.1.1 
    510             - MinGW w/ gcc version 4.6.1 (WIN) 
    511             - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008 
    512               re-distributable) 
    513             - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable 
    514  
    515             *** Note: Windows build dependencies can be set up using anaconda. Instructions 
    516                 can be found at http://trac.sasview.org/wiki/AnacondaSetup 
    517  
    518           - MAC Specifc Packages 
    519             - py2app 0.7.1 
     684            changing the C model files 
     685 
     686        -For the latest list of dependencies see the appropriate yml file in 
     687          the SasView repo at sasview/build_tools/conda/ymls  
    520688 
    521689 
     
    523691=============== 
    524692 
     693 
     694   4.2.0 - All systmes 
     695      There are currently no major known issues. A full list of known bugs and 
     696      feature requests by release version that users may wish to be aware of 
     697      can be viewed at http://trac.sasview.org/report/3 
     698      NOTE: Any corrections to models that may become known/available will be 
     699      posted to Marketplace as available (and fixed in the following release) 
    525700 
    526701   4.1- All systems: 
Note: See TracChangeset for help on using the changeset viewer.