Changeset 6b20c4e in sasview for sansview


Ignore:
Timestamp:
May 11, 2014 11:42:24 PM (11 years ago)
Author:
butler
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
a3b635b
Parents:
92a2ecd
Message:

update release notes for release 3.0. In process went over everything and did some reorganization, started filling some long standing stubs and fixed some obsolete links and statements.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sansview/README.txt

    r10be315 r6b20c4e  
    44SasView 3.0.0 
    55 
    6     - Implemented Polarization and magnetic SANS parameters in some models. 
    7     - New Tool: Generic SANS / PDB reader & atomic scattering calculator 
    8     - New Tool: Image viewer 
     6    - The GUI look and feel has been refactored to be more familiar for windows 
     7      users by using MDI frames. 
     8    - BETA:  Magnet contrast supporting full polarization Analysis has been implemented 
     9      for some spherical and cylindrical models. 
     10    - BETA Two new tools have been added 
     11       * A generic scattering calculator which takes an atomic,magnetic or SLD 
     12         distributions in space and generates the appropriate 2D scattering 
     13         pattern.  In some cases the orientationally averaged (powder) 1D 
     14         can also be computed.  Supported formats include: SLD or text; PDB; 
     15         and OMF magnetic moment distribution file. 
     16       * An image viewer/converter: for data in image format, this reader 
     17         reads in an image file and will attempt to convert the image pixels 
     18         to data.  Supported types include TIFF, TIF, PNG, BMP, JPG 
    919    - Redefined angles of angular parameters for anisotropic models 
    10     - Use MDI frames in GUI 
    11  
    12         - Previous Versions:  
    13          
    14         - Changed the application name to 'SasView'. 
    15         - Model category can be modified via (Category Manager). 
    16         - Improved Grid/Batch window functionality. 
    17         - Added a new tool; Data operation for addition, subtraction, multiplication, division, and combination of two data sets. 
    18         - Extended Sum Model Editor to Summation and Multiplication Editor. 
    19         - Better compiling error captures in the 'New' model editor. 
    20         - More outputs (e.g., Rg, background, or rod diameter) on LinearFit in certain axis scales. 
    21         - Added DataInfo for data in the DataExplorer and plots 
    22         - Added Maximize/Restore button in the title bar of the graphs 
    23         - The 'x' button now works as deleting the graph 
    24         - Added a hide button in the toolbar of the graph panel 
    25         - Fixed some bugs and improved some behaviors in the batch/grid panel. 
    26         - Edit SUM Model from the menubar can now generate more than one sum model. 
    27         - Report can now be saved as a pdf format on WIN and MAC. 
    28         - Multiprocessor support(Windows) 
    29         - Simple custom model editor 
    30         - Advanced model editor 
    31         - Sum model editing panel  
    32         - 3D graphic (for 2d data/results) and legend moves with mouse 
    33         - New Tool: density to vol fraction calculator and Python file editor 
    34         - Batch Fit included. 
    35         - More Graph modifications. 
    36         - More options for the fit weighting. 
    37         - Added a Python (PyCrust) shell in the 'Tool' menu. 
    38         - The 'Startup Setting' in the View menu can remember the last data file folder. 
    39         - Updated the resolution computation for the gravitational effect and added TOF estimation  capability. 
    40         - Fixed the problem of displaying the fit results in the wrong parameter (with ParkMC FitEngine). 
    41         - Pr Inversion: Fixed a missing Rg output 
    42         - Startup Setting: fixed a problem with DataExplorer ON/OFF 
    43         - Fixed a bug w/ 2D color map dialog 
    44         - Minor feature added: Enable to load a data folder from the command line        
    45         - Much easier graphical user interface 
    46         - Optimized for the speed and accuracy of the computations 
    47         - Added Many shape, polymer, and other models including SphericalSLD, OnionExponetialShell, and even ReflectivityModels 
    48         - Added Data Explorer to manage, plot, delete, or setup for computation 
    49         - Added Instrumental resolution estimator (as a Tool) 
    50         - Customizable Startup appearance 
    51         - More functionalities on plot panels 
    52         - Combined Modeling and Fitting 
    53         - Save/open a SasView project or SasView analysis (subproject) 
    54         - Start the SasView application from a data file by double-clicking or from command line 
    55         - Easy manipulation of data and plot 
    56         - Provides Normalized residual plot 
    57         - Added useful key-combinations to copy (fitpage), paste (fitpage), change fit-tolerance, etc. 
    58         - Report 
    59         - 2D masked circular averaging 
    60         - 2D smearing calculation now uses dQ_parrellel and dQ_perpendicular 
    61         - Improved the speed of loading 2D data. 
    62         - Improved the speed of P*S calculations. 
    63         - Added 2D smearing calculation for dQx and dQy given along the x-y axes. 
    64         - MAC release 
    65         - Implemented the invariant, volume fraction, and specific surface area computation. 
    66         - Implemented the scattering length density calculator. 
    67         - Re-structured 2D calculation to 2D reduced(Q) data rather than raw pixel data 
    68         - Capable of Mask enhanced 2D calculation and fitting. 
    69         - Added a 2D mask data editor. 
    70         - Added inputs for the slit and pinhole resolution. 
    71         - Added a slit size calculator. 
    72         - Support more format options to save a graph. 
    73         - Enable to display multiple data sets in one graph by loading a data into the graph. 
    74         - Added a tool bar in a plot panel. 
    75         - Implemented P(r) inversion (Indirect Fourier transformations). 
    76         - Improved fitting and model calculation speed by a factor of ten. 
    77         - Supporting many more model functions. 
    78         - Supporting P(Q)*S(Q) for most of the shape based form factors. 
    79         - Added more distribution functions for the polydispersion calculations. 
    80         - Added a bookmark feature so that the results of the calculation can be recalled later. 
    81         - Q range reset button is added. 
    82         - Added a color bar in 2D data plots. 
    83         - Added a model function detail button for an easy access to the model help from the fitting panel. 
    84         - Simultaneous fit of a number of different sets of data with/without the constraints.  
    85         - Loading and displaying 1D and 2D data of various formats. 
    86         - 1D and 2D data fitting using Scipy or Park (a MC fitting optimizer) fit engine.  
    87         - 2D data manipulation and modeling.  
    88         - Supporting a number of standard model and model-independent functions including form factor and structure factor functions and their multiplications.   
    89         - Plug-in mechanism for data readers.  
    90         - Easy pop-up menu by mouse clicking on a given plot.  
    91         - Users arrange the various windows.  
    92         - Supporting varius 2D averaging methods : Circular, sectorslicer, annulus, boxsum, boxQx and boxQy.   
    93         - User defined Qrange (Qmin and Qmax) for both 1D and 2D data for fitting and modeling.   
    94         - The user can toggle between a number of different scales on all plots. 
    95         - Support saving data in the formats of ASCII and xml. 
     20    - Several new models have been added 
     21    - Data loader now supports ILL DAT data files and reads the full meta  
     22      information from canSAS file formats 
     23    - A number of minor feature additions such as log distribution of point  
     24      when using a model to simulate data and the addition of a Kratky plot 
     25      to the linear plots 
     26    - a number of bug fixes 
     27 
     28    - New in Version 2.2.1 
     29      - Minor patch to support CanSAS XML v1.1 file format 
     30 
     31    - New in Version 2.2.0 
     32      - Application name changed to SasView 
     33      - New fully customizable Category Manager added for better management of 
     34        increasing number of models 
     35      - Improved the Grid Window functionality in the batch fitting mode 
     36      - Added a simpler Graph/Plot modification interface 
     37      - Added a new 'Data Operation' tool for addition, subtraction, multiplication, 
     38        division, of two data sets. 
     39      - The 'Sum Model' editor was extended and renamed 'Summation and Multiplication' 
     40        editor 
     41      - Added more plot symbols options for 1d plots 
     42      - Added improved trapping of compiling errors to the 'New model editor' 
     43      - Added some intelligent outputs (e.g., Rg, background, or rod diameter depending on the choice of axis scale of the plot) to the linear fits 
     44      - Added more models 
     45 
     46    - Feature set from Previous Versions:        
     47     
     48    - Perspectives Available 
     49      - Invariant calculator: Calculates the invariant, volume fraction, and 
     50        specific surface area. 
     51      - P(r) inversion calculator: Indirect Fourier transformation method. 
     52      - Fitting: the tool used for modeling and fitting 1D and 2D data to  
     53        analytical model functions 
     54      - Tools: provides a number of useful supplementary tools such as SLD 
     55        calculation   
     56     
     57    - Fitting  
     58      - Includes a large number of model functions, both form factors and structure factors. 
     59      - Support P(Q)*S(Q) for form factors that flag they can be so multiplied. 
     60      - Supports Gaussian, lognormal, Shulz, rectangular and custom distribution 
     61        functions for models that need to include polydispersity or for orientational 
     62        distributions if appropriate. 
     63      - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform 
     64        distribution of orientations of a given axis leading to modeling and fitting 
     65        capabilities of non azimuthaly symmetric data.   
     66      - User can choose to weight fits or not. If using weights, the user can choose 
     67        the error bar on each point if provided in the file, the square root 
     68        of the intensity or the intensity itself.  
     69      - Instrumental resolution smearing of model or fits is provided with several 
     70        options: read the resolution/point fromt he file. Input a pinhole resolution 
     71        or a slit resolution. 
     72      - Users can define the Qrange (Qmin and Qmax) for both 1D and 2D data for 
     73        fitting and modeling, but not graphically.  The range can be reset to the 
     74        defaults (limits of q in data set for a fit) with the reset button. 
     75      - A mask can be applied to 2D calculation and fitting. 
     76      - Normalized residual plots are provided with every fit. 
     77      - Model function help available through detail button or from the fitting panel. 
     78      - Simultaneous/(advanced)constrained fitting allows for fitting a single 
     79        data set or several different sets simultaneously with the application 
     80        of advanced constraints relating fit parameters to functions of other 
     81        parameters (including from a different set). For example thickness of  
     82        shell = sin(30) times the length.   
     83      - Models that are the sum of two other models can be easily generated through the 
     84        SUM Model menubar item. 
     85      - New Python models can be added on the fly by creating an appropriate Python 
     86        file in the model plugin directory. Two tools are provided to help: 
     87        An easy to use custom model editor allows the quick generation of new Python 
     88        models by supplying only the parameters and their default value (box 1) 
     89        and the mathematical function of the model (box 2) and generating the 
     90        necessary *.py file.  A separate advanced model editor provides a full Python 
     91        file editor.  Either way once saved the model becomes immediately available  
     92        to the application.  
     93      - A batch fittng capability allows for the analysis of a series of data sets to 
     94        a sinble model and provides the results in a tabular form suitable for saving 
     95        or plotting the evolution of the fit parameters with error bars (from within 
     96        the application). 
     97  
     98    - Tools 
     99      - A scattering length density calculator,including some X-ray information 
     100        is provided. 
     101      - A density to vol. fraction converter is provided 
     102      - In application access to a Python shell/editor (PyCrust) is provided 
     103      - An instrument resolution calculator, including possible gravitational and 
     104        TOF effects is provided 
     105      - A slit size calculator optimized for Anton Paar Saxess is provided. 
     106      - A kiessig fringe thickness calculator is provided 
     107    - Plots and plot management 
     108      - A 3D graphing option (for 2d data/results) is provided with the view 
     109        controlled by the mouse 
     110      - 2D plots are shown with an intensity color bar. 2D Color map can be user 
     111        adjusted. 
     112      - Supports output of plot to a variety of graphic formats. Supported formats 
     113        include: png, eps, emf, jpg/jpeg, pdf, ps, tif/tiff, rawRGBbitmap(raw, rgba), 
     114        and scalable vector graphic (svg/svgz) 
     115      - Supports ouput of data in plot (1 or 2D) to limited data formats 
     116      - Multiple data sets can be loaded into a single graph for viewing (but a fit 
     117        plot can currently only have a single plot). 
     118      - Extensive context sensitive plot/fitting/manipulation options are available 
     119        through a right mouse click pop-up menu on plots.   
     120    - Data management 
     121      - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data 
     122        via plug-in mechanism which can easily allow other readers as appropriate.  
     123      - 2D data is expected in Q space but for historical reasons accepts the 
     124        NIST 2D raw pixel format and will do conversion internally. 
     125      - The full data and metadata available to SasView is viewable in ASCII via 
     126        right clicking on a data set and choosing Data Info in the DataExplorer 
     127        or on the plots 
     128      - Supports loading a single file, multiple files, or a whole folder    
     129      - An optional Data Explorer is provided (default) which simplifies managing, 
     130        plotting, deleting, or setup for computation. Most functions however do 
     131        not require access to the explorer/manager and can be accessed through 
     132        right click menus and the toolbar.  The data explorer can be re-started 
     133        from the menu bar. 
     134    - Data manipulation 
     135      - Support various 2D averaging methods : Circular, sectors, annular, 
     136        boxsum, boxQx and boxQy. 
     137      - A 2D data maks editor is provided 
     138      - 2D mask can be applied to the circular averaging. 
     139    - Miscellaneous features 
     140      - limited reports can be generated in pdf format 
     141      - Provides multiprocessor support(Windows only) 
     142      - Limited startup customization currently includes default startup 
     143        data folder and choice of default starting with data manager 
     144      - Limited support for saving(opening) a SasView project or a SasView analysis 
     145        (subproject) is provided. 
     146      - SasView can be launched and loaded with a file of interesty by double-clicking 
     147        on that file (recognized extension) 
     148      - A data file or data folder can be passed to SasView when launched from 
     149        the command line. 
     150      - Limited bookmarking capability to later recall the results of a fit calculation 
     151        is provided. 
     152      - Extensive help is provided through context sensitive mouse roll-over, 
     153        information bar (at the bottom of the panel), the console menu, and 
     154        access to the help files in several different ways. 
     155 
    96156 
    97157 
    981582- Downloading and Installing 
    99159         
    100         *** Note: If you have EXE or ZIP SasView installer, you don't need any of the following. 
    101          
    102         2.1- System Requirements: 
    103                 - Python version >= 2.5 and < 3.0 should be running on the system 
    104                 - We currently use Python 2.6 
    105  
    106         2.2- Installing from source: 
    107                 - Get the code from https://sasviewproject.svn.sourceforge.net/svnroot/sansviewproject/releases/sasview-x.x.x 
    108                         - run 'python setup.py install' under the 'sasview-x.x.x' folder 
    109                         - run 'python sasview.py' under the 'sasview' folder. 
    110                 - The following modules are required (version numbers are what are used in the release build): 
    111                         - wxPython 2.8.12.1 (NOTE: do NOT use version 2.9) 
    112                         - matplotlib 1.1.0  (NOTE: Mac build is using version 1.0.1) 
    113                         - SciPy 0.10.1 
    114                         - pisa 3.0.27 (NOTE Mac Version uses 3.0.33 BUT -- DO NOT USE ver 3.0.33 on windows: it will not work!) 
    115                         - setuptools 0.6c11 
    116  
    117                         (The following three are easily installed using easy_install) 
    118                         - lxml 2.3.0 
    119                         - numpy 1.6.1 (NOTE: Mac build is using version 1.5.1) 
    120                         - periodictable 1.3.0 
    121  
    122                         (The following are additional dependencies for Mac) 
    123                         - py2app 
    124  
    125                         (The following are additional dependencies for Windows) 
    126                         - comtypes 0.6.2 (for PDF support on windows systems) 
    127                         - pywin32 build 217 (to read ms office) 
    128                         - pyPdf 1.13 
    129                         - html5lib 0.95 
    130                         - reportlab 2.5 
    131                         - pyparsing 1.5.5 (required for periodictable and bundling) 
    132                         - PIL 1.1.7 (Python Image Library) 
    133                         - py2exe 0.6.9 (WIN) 
    134                         - svn 
    135                         - MinGW w/ gcc version 4.6.1 (WIN) 
    136                         - Innosetup (WIN). 
    137  
    138                         (On Windows, the following site has all the dependencies nicely packaged) 
    139                         http://www.lfd.uci.edu/~gohlke/pythonlibs/ 
     160        *** Note 1:  Much more information is available at www.sasview.org under links. 
     161                     Look in the 'For Developers' section and particularly the wiki at 
     162                     www.sasview.org/trac/wiki. 
     163    *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of 
     164                 the following. 
     165 
     166    2.1- System Requirements: 
     167        - Python version >= 2.5 and < 3.0 should be running on the system 
     168        - We currently use Python 2.6 
     169 
     170    2.2- Installing from source: 
     171        - Get the code from sourceforge at https://svn.code.sf.net/p/sasview/code/ 
     172          for trunk end with code/trunk for a this release version end in  
     173          code/releases/sasview-3.0.0 
     174            - run 'python setup.py install' under the 'sasview-x.x.x' folder 
     175            - run 'python sasview.py' under the 'sasview' folder. 
     176        - The following modules are required (version numbers are what are used in the release build): 
     177            - wxPython 2.8.12.1 (NOTE: do NOT use version 2.9) 
     178            - matplotlib 1.1.0 
     179            - SciPy 0.10.1 (NOTE: Mac build uses 0.10.0) 
     180            - pisa 3.0.27 (DO NOT USE ver 3.0.33 on windows: it will not work!) 
     181            - setuptools 0.6c11 
     182 
     183            (The following three are easily installed using easy_install) 
     184            - lxml 2.3.0.0 (NOTE: Mac build uses 3.1.0.0) 
     185            - numpy 1.6.1 (NOTE: Mac build uses version 1.6.2) 
     186            - periodictable 1.3.0 
     187             
     188            (The following are additional dependencies for Mac) 
     189            - py2app 0.7.1 
     190             
     191            (The following are additional dependencies for Windows) 
     192            - comtypes 0.6.2 (for PDF support on windows systems) 
     193            - pywin32 build 217 (to read ms office) 
     194            - html5lib 0.95-dev 
     195            - reportlab 2.5 (NOTE: Mab build uses 2.6 though should not be needed) 
     196            - pyparsing 1.5.5 (required for periodictable and bundling 
     197              NOTE: is ALSO present on Mac Build) 
     198            - PIL 1.1.7 (Python Image Library - NOTE: is also present on Mac build) 
     199            - py2exe 0.6.9 (WIN) 
     200            - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008  
     201              re-distributable) 
     202            - subversion -1.6.0 (<1.6.1) 
     203            - MinGW w/ gcc version 4.6.1 (WIN) 
     204            - Innosetup (WIN - isetup 5.4.2-unicode). 
     205             
     206            (On Windows, the following site has all the dependencies nicely packaged) 
     207            http://www.lfd.uci.edu/~gohlke/pythonlibs/ 
    140208 
    141209 
    1422103- Known Issues 
    143211 
    144         3.1- All systems: 
    145                 - very old computers may not be able to run  
    146  
    147         3.2- Windows: 
    148                 - None 
     212    3.1- All systems: 
     213        - very old computers may not be able to run 
     214        - polydispersity on multiple parameters included in a simultaneous/ 
     215          constrained fit will likely not be correct 
     216        - Save project does not store the state of all the windows 
     217 
     218    3.2- Windows: 
     219        - None 
    149220                 
    150         3.3- MAC: 
    151                 - None 
     221    3.3- MAC: 
     222        - multiprocessing does not currently work on MAC OS 
    152223                 
    153         3.4- Linux: 
    154                 - None 
    155  
    156 4- Troubleshooting 
    157  
    158         - None 
     224    3.4- Linux: 
     225        - None 
     226 
     2274- SasView website 
     228 
     229    - www.sasview.org.  This main project site is the gateway to all  
     230      information about the sasview project.  It includes information 
     231      about the project, a FAQ page and links to all developer and user 
     232      information, tools and resources. 
    159233 
    1602345- Frequently Asked Questions 
    161235 
    162         - None 
     236    - www.sasview.org/faq.html 
    163237 
    1642386- Installer download website 
    165239 
    166         - http://sourceforge.net/projects/sansviewproject/files/ 
     240    - Latest release Version 
     241        - http://sourceforge.net/projects/sasview/files/ 
     242    - Latest developer Windows or Ubuntu build 
     243        - http://build.sasview.org/ 
     244    - Latest developer Mac OS build 
     245        - http://download.mantidproject.org/jenkins/view/All/job/sasview_snowleopard_32bit/ 
     246 
     247     
Note: See TracChangeset for help on using the changeset viewer.