Changes in sasview/README.txt [243fbc0:9a182b2] in sasview


Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • sasview/README.txt

    r243fbc0 r9a182b2  
    441- Features 
    55=========== 
     6    - New in Version 4.0 
     7      ------------------ 
     8      This release fixes the various bugs found during the alpha and beta testing 
     9      - Improvements 
     10        - Support for reading data files from Anton Paar Saxess instruments 
     11        - Adds documentation on how to write custom models in the new framework 
     12      - Bug Fixes 
     13        - Fixes bug #604 Pringle model questions 
     14        - Fixes bug #472 Reparameterize Teubner-Strey 
     15        - Fixes bug #530 Numerical instabilities in Teubner Strey model 
     16        - Fixes bug #658 ASCII reader very broken 
     17 
     18 
     19    - New in Version 4.0 beta 1 
     20      -------------------- 
     21      This beta adds support for the magnetic and multilevel models of 3.1.2 
     22      and along with a host of bug fixes found in the alpha. 
     23 
     24      - Model package changes and improvements 
     25         - All 3.1.2 models now available in new interface 
     26         - Old custom models should now still work 
     27            - '''NOTE:''' These will be deprecated in a future version. Old 
     28            custom models should be converted to the new model format which 
     29            is now the same as the built in models and offers much better 
     30            support. 
     31         - Custom model editor now creates new style models 
     32         - Custom model editor supports better error checking 
     33      - Documentation improvements 
     34        - Continued general cleanup 
     35      - Other improvements/additions 
     36         - Support for new canSAS 2D data files added 
     37         - Plot axes range can now be set manually as well as by zooming 
     38         - Plot annotations can now be moved around after being placed on plot. 
     39         - The active optimizer is now listed on the top of the fit panel. 
     40         - Linear fits now update qmin and max when the x scale limits are 
     41         changed.  Also the plot range no longer resets after a fit. 
     42      - Bug fixes 
     43         - Fixes bug #511 Errors in linearized fits and clean up of interface 
     44         including Kratky representation 
     45         - Fixes bug #186 Data operation Tool now executes when something is 
     46         entered in the text box and does not wait for the user to hit enter 
     47         - Fixes bug #459 plot context menu bug 
     48         - Fixes bug #559 copy to clipboard in graph menu broken 
     49         - Fixes bug #466 cannot remove a linear fit from graph 
     50         - Numerous bugs introduced in the alpha 
     51 
     52 
    653 
    754    - New in Version 4.0.0-alpha 
     
    4491   - New in Version 3.1.2 
    4592     -------------------- 
    46      This release is a major stability improvement, having fixed a serious bug  
     93     This release is a major stability improvement, having fixed a serious bug 
    4794     that came to light since release 3.1.1. All users should upgrade. 
    4895 
    49      - Fixes bug #468 broken remove constraint buttons in  
     96     - Fixes bug #468 broken remove constraint buttons in 
    5097       simultaneous/constrained fitting panel 
    51      - Fixes bug #474 resulting from changes in 3.1.1 that had  
     98     - Fixes bug #474 resulting from changes in 3.1.1 that had 
    5299       introduced an error in the high-Q of slit-smeared models. 
    53      - Fixes bug #478 which would cause wx to run out of IDs and result  
     100     - Fixes bug #478 which would cause wx to run out of IDs and result 
    54101       in SasView crashing even if left alone. 
    55102     - Fixes bug #479 missing help button on simultaneous/constrained fit page 
     
    75122         documentation. 
    76123       - The model help has been split so that the Details button now brings up 
    77          a very short pop-up giving the equation being used while HELP goes to  
     124         a very short pop-up giving the equation being used while HELP goes to 
    78125         the section in the full documentation describing the model. 
    79        - Extensive help has also been added for the new optimizer engine (see  
     126       - Extensive help has also been added for the new optimizer engine (see 
    80127         below) including rules of thumb on how and when to choose a given 
    81128         optimizer and what the parameters do. 
     
    92139         - A Nelder-Mead Simplex optimizer 
    93140         - A Differential Evolution optimizer 
    94          - A Monte Carlo optimizer (DREAM)  
     141         - A Monte Carlo optimizer (DREAM) 
    95142     - New models were added: 
    96143         - MicelleSphCoreModel (currently residing in the Uncategorized category) 
     
    101148         - RectangularHollowPrismInfThinWallsModel 
    102149     - Infrastructure to allow SESANS data to be fit with models was added. This 
    103        will become available in a future release but can currently be used from  
     150       will become available in a future release but can currently be used from 
    104151       the command line with some caveats. 
    105152     - A number of bugs were fixed including a thread crashing issue and an 
     
    126173       floating. 
    127174     - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel, 
    128        RectangularPrismModel, RectangularHollowPrismModel and  
     175       RectangularPrismModel, RectangularHollowPrismModel and 
    129176       RectangularHollowPrismInfThinWallsModel. 
    130      - The data loader now supports ILL DAT data files and reads the full meta  
     177     - The data loader now supports ILL DAT data files and reads the full meta 
    131178       information from canSAS file formats. 
    132179     - Redefined convention for specifying angular parameters for anisotropic 
    133180       models. 
    134      - A number of minor features have been added such as permitting a log  
    135        distribution of points when using a model to simulate data, and the  
     181     - A number of minor features have been added such as permitting a log 
     182       distribution of points when using a model to simulate data, and the 
    136183       addition of a Kratky plot option to the linear plots. 
    137184     - A number of bugs have also been fixed. 
    138185     - Save Project and Save Analysis now work more reliably. 
    139      - BETA: Magnetic contrast supporting full polarization analysis has been  
     186     - BETA: Magnetic contrast supporting full polarization analysis has been 
    140187       implemented for some spherical and cylindrical models. 
    141188     - BETA: Two new tools have been added: 
    142        - A generic scattering calculator which takes an atomic, magnetic or  
    143          SLD distribution in space and generates the appropriate 2D  
    144          scattering pattern. In some cases the orientationally averaged  
    145          (powder) 1D scattering can also be computed. Supported formats  
    146          include: SLD or text, PDB, and OMF magnetic moment distribution  
     189       - A generic scattering calculator which takes an atomic, magnetic or 
     190         SLD distribution in space and generates the appropriate 2D 
     191         scattering pattern. In some cases the orientationally averaged 
     192         (powder) 1D scattering can also be computed. Supported formats 
     193         include: SLD or text, PDB, and OMF magnetic moment distribution 
    147194         file. 
    148        - An image viewer/converter for data in image format; this reads in  
    149          an image file and will attempt to convert the image pixels to  
     195       - An image viewer/converter for data in image format; this reads in 
     196         an image file and will attempt to convert the image pixels to 
    150197         data. Supported formats include: TIFF, TIF, PNG, BMP, JPG. 
    151198 
     
    175222     - Added more plot symbols options for 1d plots 
    176223     - Added improved trapping of compiling errors to the 'New model editor' 
    177      - Added some intelligent outputs (e.g., Rg, background, or rod diameter  
     224     - Added some intelligent outputs (e.g., Rg, background, or rod diameter 
    178225       depending on the choice of axis scale of the plot) to the linear fits 
    179226     - Added more models 
    180       
    181    - Feature set from previous versions          
     227 
     228   - Feature set from previous versions 
    182229     ----------------------------------- 
    183230     - Perspectives Available 
     
    185232         specific surface area. 
    186233       - P(r) inversion calculator: Indirect Fourier transformation method. 
    187        - Fitting: the tool used for modeling and fitting 1D and 2D data to  
     234       - Fitting: the tool used for modeling and fitting 1D and 2D data to 
    188235         analytical model functions 
    189236       - Tools: provides a number of useful supplementary tools such as SLD 
    190          calculation   
    191      
    192      - Fitting  
     237         calculation 
     238 
     239     - Fitting 
    193240       - Includes a large number of model functions, both form factors and structure factors. 
    194241       - Support P(Q)*S(Q) for form factors that flag they can be so multiplied. 
     
    198245       - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform 
    199246         distribution of orientations of a given axis leading to modeling and fitting 
    200          capabilities of non azimuthaly symmetric data.   
     247         capabilities of non azimuthaly symmetric data. 
    201248       - User can choose to weight fits or not. If using weights, the user can choose 
    202249         the error bar on each point if provided in the file, the square root 
    203          of the intensity or the intensity itself.  
     250         of the intensity or the intensity itself. 
    204251       - Instrumental resolution smearing of model or fits is provided with several 
    205252         options: read the resolution/point fromt he file. Input a pinhole resolution 
     
    214261         data set or several different sets simultaneously with the application 
    215262         of advanced constraints relating fit parameters to functions of other 
    216          parameters (including from a different set). For example thickness of  
    217          shell = sin(30) times the length.   
     263         parameters (including from a different set). For example thickness of 
     264         shell = sin(30) times the length. 
    218265       - Models that are the sum of two other models can be easily generated through the 
    219266         SUM Model menubar item. 
     
    224271         and the mathematical function of the model (box 2) and generating the 
    225272         necessary *.py file.  A separate advanced model editor provides a full Python 
    226          file editor.  Either way once saved the model becomes immediately available  
    227          to the application.  
     273         file editor.  Either way once saved the model becomes immediately available 
     274         to the application. 
    228275       - A batch fitting capability allows for the analysis of a series of data sets to 
    229276         a single model and provides the results in a tabular form suitable for saving 
    230277         or plotting the evolution of the fit parameters with error bars (from within 
    231278         the application). 
    232   
     279 
    233280     - Tools 
    234281       - A scattering length density calculator,including some X-ray information 
     
    240287       - A slit size calculator optimized for Anton Paar Saxess is provided. 
    241288       - A kiessig fringe thickness calculator is provided 
    242           
     289 
    243290     - Plots and plot management 
    244291       - A 3D graphing option (for 2d data/results) is provided with the view 
     
    254301       - Extensive context sensitive plot/fitting/manipulation options are available 
    255302         through a right mouse click pop-up menu on plots. 
    256             
     303 
    257304     - Data management 
    258305       - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data 
    259          via plug-in mechanism which can easily allow other readers as appropriate.  
     306         via plug-in mechanism which can easily allow other readers as appropriate. 
    260307       - 2D data is expected in Q space but for historical reasons accepts the 
    261308         NIST 2D raw pixel format and will do conversion internally. 
     
    263310         right clicking on a data set and choosing Data Info in the DataExplorer 
    264311         or on the plots 
    265        - Supports loading a single file, multiple files, or a whole folder    
     312       - Supports loading a single file, multiple files, or a whole folder 
    266313       - An optional Data Explorer is provided (default) which simplifies managing, 
    267314         plotting, deleting, or setup for computation. Most functions however do 
     
    269316         right click menus and the toolbar.  The data explorer can be re-started 
    270317         from the menu bar. 
    271             
     318 
    272319     - Data manipulation 
    273320       - Support various 2D averaging methods : Circular, sectors, annular, 
     
    275322       - A 2D data maks editor is provided 
    276323       - 2D mask can be applied to the circular averaging. 
    277           
     324 
    278325     - Miscellaneous features 
    279326       - limited reports can be generated in pdf format 
     
    2963432- Downloading and Installing 
    297344============================= 
    298          
     345 
    299346   *** Note 1:  Much more information is available at www.sasview.org under links. 
    300347                    Look in the 'For Developers' section and particularly the wiki at 
     
    335382        - The following modules are required (version numbers are what are used 
    336383          in the windows release build): 
    337            
     384 
    338385          - Common Packages 
    339386            - reportlab 3.1.44 
     
    352399            - html5lib Version Installed: 0.99999 
    353400            - wx Version Installed: 3.0.2.0 
    354            
     401 
    355402          - Windows Specific Packages 
    356403            - pywin 219 
     
    358405            - comtypes 1.1.1 
    359406            - MinGW w/ gcc version 4.6.1 (WIN) 
    360             - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008  
     407            - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008 
    361408              re-distributable) 
    362409            - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable 
     
    364411            *** Note: Windows build dependencies can be set up using anaconda. Instructions 
    365412                can be found at http://trac.sasview.org/wiki/AnacondaSetup 
    366              
     413 
    367414          - MAC Specifc Packages 
    368415            - py2app 0.7.1 
    369            
     416 
    370417 
    3714183- Known Issues 
     
    377424          equations will render properly. Until then they will show in their 
    378425          original TeX format. 
    379         - If the documentation window remains stubbornly blank, try installing a  
     426        - If the documentation window remains stubbornly blank, try installing a 
    380427          different browser and set that as your default browser. Issues have 
    381428          been noted with Internet Explorer 11. 
    382         - Check for Updates may fail (with the status bar message ' Cannot  
    383           connect to the application server') if your internet connection uses  
    384           a proxy server. Tested resolutions for this are described on the  
     429        - Check for Updates may fail (with the status bar message ' Cannot 
     430          connect to the application server') if your internet connection uses 
     431          a proxy server. Tested resolutions for this are described on the 
    385432          website FAQ. 
    386433        - The copy and paste functions (^C, ^V) in the batch mode results grid 
    387434          require two clicks: one to select the cell and a second to select the 
    388           contents of the cell.  
     435          contents of the cell. 
    389436        - The tutorial has not yet been updated and is somewhat out of date 
    390437        - Very old computers may struggle to run the 3.x and later releases 
     
    401448        - The angular distribution angles are not clearly defined and may in 
    402449          some cases lead to incorrect calculations(ticket #332) 
    403            
     450 
    404451   3.2- Windows: 
    405452        - If installed to same directory as old version without first removing 
     
    408455          have the old name even though pointing to the new version.  Usually 
    409456          safest to uninstall old version prior to installing new version anyway. 
    410                  
     457 
    411458   3.3- MAC: 
    412459        - Application normally starts up hidden. Click icon in Dock to view/use 
    413           application.  
     460          application. 
    414461        - Multiprocessing does not currently work on MAC OS 
    415                  
     462 
    416463   3.4- Linux: 
    417464        - Not well tested 
     
    421468================== 
    422469 
    423    - www.sasview.org.  This main project site is the gateway to all  
     470   - www.sasview.org.  This main project site is the gateway to all 
    424471     information about the sasview project.  It includes information 
    425472     about the project, a FAQ page and links to all developer and user 
     
    440487   - Latest developer builds 
    441488     - https://jenkins.esss.dk/sasview/view/Master-Builds/ 
    442  
    443      
Note: See TracChangeset for help on using the changeset viewer.