source: sasview/sansview/README.txt @ 69ef722

Release Notes
=============

SasView 3.0.0

    - The GUI look and feel has been refactored to be more familiar for Windows
      users by using MDI frames. Graph windows are also now free-floating
    - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel,
      RectangularPrismModel, RectangularHollowPrismModel and 
      RectangularHollowPrismInfThinWallsModel
    - The data loader now supports ILL DAT data files and reads the full meta 
      information from canSAS file formats
    - Redefined convention for specifying angular parameters for anisotropic models
    - A number of minor features have been added such as permitting a log 
      distribution of points when using a model to simulate data, and the 
      addition of a Kratky plot option to the linear plots
    - a number of bugs have also been fixed      
    - BETA: Magnetic contrast supporting full polarization analysis has been 
            implemented for some spherical and cylindrical models
    - BETA: Two new tools have been added:
            * A generic scattering calculator which takes an atomic, magnetic or 
              SLD distribution in space and generates the appropriate 2D 
              scattering pattern. In some cases the orientationally averaged 
              (powder) 1D scattering can also be computed. Supported formats 
              include: SLD or text, PDB, and OMF magnetic moment distribution 
              file.
            * An image viewer/converter for data in image format; this reads in 
              an image file and will attempt to convert the image pixels to 
              data. Supported formats include: TIFF, TIF, PNG, BMP, JPG

    - New in Version 2.2.1
      - Minor patch to support CanSAS XML v1.1 file format

    - New in Version 2.2.0
      - Application name changed to SasView
      - New fully customizable Category Manager added for better management of
        increasing number of models
      - Improved the Grid Window functionality in the batch fitting mode
      - Added a simpler Graph/Plot modification interface
      - Added a new 'Data Operation' tool for addition, subtraction, multiplication,
        division, of two data sets.
      - The 'Sum Model' editor was extended and renamed 'Summation and Multiplication'
        editor
      - Added more plot symbols options for 1d plots
      - Added improved trapping of compiling errors to the 'New model editor'
      - 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
      - Added more models

    - Feature set from Previous Versions:       
    
    - Perspectives Available
      - Invariant calculator: Calculates the invariant, volume fraction, and
        specific surface area.
      - P(r) inversion calculator: Indirect Fourier transformation method.
      - Fitting: the tool used for modeling and fitting 1D and 2D data to 
        analytical model functions
      - Tools: provides a number of useful supplementary tools such as SLD
        calculation  
    
    - Fitting 
      - Includes a large number of model functions, both form factors and structure factors.
      - Support P(Q)*S(Q) for form factors that flag they can be so multiplied.
      - Supports Gaussian, lognormal, Shulz, rectangular and custom distribution
        functions for models that need to include polydispersity or for orientational
        distributions if appropriate.
      - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform
        distribution of orientations of a given axis leading to modeling and fitting
        capabilities of non azimuthaly symmetric data.  
      - User can choose to weight fits or not. If using weights, the user can choose
        the error bar on each point if provided in the file, the square root
        of the intensity or the intensity itself. 
      - Instrumental resolution smearing of model or fits is provided with several
        options: read the resolution/point fromt he file. Input a pinhole resolution
        or a slit resolution.
      - Users can define the Qrange (Qmin and Qmax) for both 1D and 2D data for
        fitting and modeling, but not graphically.  The range can be reset to the
        defaults (limits of q in data set for a fit) with the reset button.
      - A mask can be applied to 2D calculation and fitting.
      - Normalized residual plots are provided with every fit.
      - Model function help available through detail button or from the fitting panel.
      - Simultaneous/(advanced)constrained fitting allows for fitting a single
        data set or several different sets simultaneously with the application
        of advanced constraints relating fit parameters to functions of other
        parameters (including from a different set). For example thickness of 
        shell = sin(30) times the length.  
      - Models that are the sum of two other models can be easily generated through the
        SUM Model menubar item.
      - New Python models can be added on the fly by creating an appropriate Python
        file in the model plugin directory. Two tools are provided to help:
        An easy to use custom model editor allows the quick generation of new Python
        models by supplying only the parameters and their default value (box 1)
        and the mathematical function of the model (box 2) and generating the
        necessary *.py file.  A separate advanced model editor provides a full Python
        file editor.  Either way once saved the model becomes immediately available 
        to the application. 
      - A batch fittng capability allows for the analysis of a series of data sets to
        a sinble model and provides the results in a tabular form suitable for saving
        or plotting the evolution of the fit parameters with error bars (from within
        the application).
 
    - Tools
      - A scattering length density calculator,including some X-ray information
        is provided.
      - A density to vol. fraction converter is provided
      - In application access to a Python shell/editor (PyCrust) is provided
      - An instrument resolution calculator, including possible gravitational and
        TOF effects is provided
      - A slit size calculator optimized for Anton Paar Saxess is provided.
      - A kiessig fringe thickness calculator is provided
    - Plots and plot management
      - A 3D graphing option (for 2d data/results) is provided with the view
        controlled by the mouse
      - 2D plots are shown with an intensity color bar. 2D Color map can be user
        adjusted.
      - Supports output of plot to a variety of graphic formats. Supported formats
        include: png, eps, emf, jpg/jpeg, pdf, ps, tif/tiff, rawRGBbitmap(raw, rgba),
        and scalable vector graphic (svg/svgz)
      - Supports ouput of data in plot (1 or 2D) to limited data formats
      - Multiple data sets can be loaded into a single graph for viewing (but a fit
        plot can currently only have a single plot).
      - Extensive context sensitive plot/fitting/manipulation options are available
        through a right mouse click pop-up menu on plots.  
    - Data management
      - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data
        via plug-in mechanism which can easily allow other readers as appropriate. 
      - 2D data is expected in Q space but for historical reasons accepts the
        NIST 2D raw pixel format and will do conversion internally.
      - The full data and metadata available to SasView is viewable in ASCII via
        right clicking on a data set and choosing Data Info in the DataExplorer
        or on the plots
      - Supports loading a single file, multiple files, or a whole folder   
      - An optional Data Explorer is provided (default) which simplifies managing,
        plotting, deleting, or setup for computation. Most functions however do
        not require access to the explorer/manager and can be accessed through
        right click menus and the toolbar.  The data explorer can be re-started
        from the menu bar.
    - Data manipulation
      - Support various 2D averaging methods : Circular, sectors, annular,
        boxsum, boxQx and boxQy.
      - A 2D data maks editor is provided
      - 2D mask can be applied to the circular averaging.
    - Miscellaneous features
      - limited reports can be generated in pdf format
      - Provides multiprocessor support(Windows only)
      - Limited startup customization currently includes default startup
        data folder and choice of default starting with data manager
      - Limited support for saving(opening) a SasView project or a SasView analysis
        (subproject) is provided.
      - SasView can be launched and loaded with a file of interesty by double-clicking
        on that file (recognized extension)
      - A data file or data folder can be passed to SasView when launched from
        the command line.
      - Limited bookmarking capability to later recall the results of a fit calculation
        is provided.
      - Extensive help is provided through context sensitive mouse roll-over,
        information bar (at the bottom of the panel), the console menu, and
        access to the help files in several different ways.



2- Downloading and Installing
        
        *** Note 1:  Much more information is available at www.sasview.org under links.
                     Look in the 'For Developers' section and particularly the wiki at
                     www.sasview.org/trac/wiki.
    *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of
                 the following.

    2.1- System Requirements:
        - Python version >= 2.5 and < 3.0 should be running on the system
        - We currently use Python 2.6

    2.2- Installing from source:
        - Get the code from sourceforge at https://svn.code.sf.net/p/sasview/code/
          for trunk end with code/trunk for a this release version end in 
          code/releases/sasview-3.0.0
            - run 'python setup.py install' under the 'sasview-x.x.x' folder
            - run 'python sasview.py' under the 'sasview' folder.
        - The following modules are required (version numbers are what are used in the release build):
            - wxPython 2.8.12.1 (NOTE: do NOT use version 2.9)
            - matplotlib 1.1.0
            - SciPy 0.10.1 (NOTE: Mac build uses 0.10.0)
            - pisa 3.0.27 (DO NOT USE ver 3.0.33 on windows: it will not work!)
            - setuptools 0.6c11

            (The following three are easily installed using easy_install)
            - lxml 2.3.0.0 (NOTE: Mac build uses 3.1.0.0)
            - numpy 1.6.1 (NOTE: Mac build uses version 1.6.2)
            - periodictable 1.3.0
            
            (The following are additional dependencies for Mac)
            - py2app 0.7.1
            
            (The following are additional dependencies for Windows)
            - comtypes 0.6.2 (for PDF support on windows systems)
            - pywin32 build 217 (to read ms office)
            - html5lib 0.95-dev
            - reportlab 2.5 (NOTE: Mab build uses 2.6 though should not be needed)
            - pyparsing 1.5.5 (required for periodictable and bundling
              NOTE: is ALSO present on Mac Build)
            - PIL 1.1.7 (Python Image Library - NOTE: is also present on Mac build)
            - py2exe 0.6.9 (WIN)
            - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008 
              re-distributable)
            - subversion -1.6.0 (<1.6.1)
            - MinGW w/ gcc version 4.6.1 (WIN)
            - Innosetup (WIN - isetup 5.4.2-unicode).
            
            (On Windows, the following site has all the dependencies nicely packaged)
            http://www.lfd.uci.edu/~gohlke/pythonlibs/


3- Known Issues

    3.1- All systems:
        - very old computers may not be able to run
        - polydispersity on multiple parameters included in a simultaneous/
          constrained fit will likely not be correct
        - Save project does not store the state of all the windows

    3.2- Windows:
        - None
                
    3.3- MAC:
        - multiprocessing does not currently work on MAC OS
                
    3.4- Linux:
        - None

4- SasView website

    - www.sasview.org.  This main project site is the gateway to all 
      information about the sasview project.  It includes information
      about the project, a FAQ page and links to all developer and user
      information, tools and resources.

5- Frequently Asked Questions

    - www.sasview.org/faq.html

6- Installer download website

    - Latest release Version
        - http://sourceforge.net/projects/sasview/files/
    - Latest developer Windows or Ubuntu build
        - http://build.sasview.org/
    - Latest developer Mac OS build
        - http://download.mantidproject.org/jenkins/view/All/job/sasview_snowleopard_32bit/