Changeset 74d5dbf in sasview for sasview/README.txt


Ignore:
Timestamp:
Jun 21, 2015 10:22:08 PM (9 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:
038ccfe6
Parents:
c8d22ec
Message:

Update release notes in preparation for release

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sasview/README.txt

    r79492222 r74d5dbf  
    22============= 
    33 
    4 SasView 3.0.0 
    5  
    6     - The GUI look and feel has been refactored to be more familiar for Windows 
    7       users by using MDI frames. Graph windows are also now free-floating 
    8     - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel, 
    9       RectangularPrismModel, RectangularHollowPrismModel and  
    10       RectangularHollowPrismInfThinWallsModel 
    11     - The data loader now supports ILL DAT data files and reads the full meta  
    12       information from canSAS file formats 
    13     - Redefined convention for specifying angular parameters for anisotropic models 
    14     - A number of minor features have been added such as permitting a log  
    15       distribution of points when using a model to simulate data, and the  
    16       addition of a Kratky plot option to the linear plots 
    17     - A number of bugs have also been fixed 
    18     - Save Project and Save Analysis now work more reliably 
    19     - BETA: Magnetic contrast supporting full polarization analysis has been  
    20             implemented for some spherical and cylindrical models 
    21     - BETA: Two new tools have been added: 
     4SasView 3.1.0 
     5    -The documentation/help has had a complete overhaul including 
     6      - A completely new interface. 
     7      - The text has had a clean-up and been brought up to date with the latest 
     8        features. 
     9      - A Help (or sometimes ?) button has been added to every panel, and some 
     10        sub panels if appropriate, linking to the appropriate section in the 
     11        documentation. 
     12      - The model help has been split so that the details button now brings up 
     13        a very short pop-up giving the equation being used while HELP goes to  
     14        the section in the full documentation describing the model. 
     15      - Extensive help has also been added for the new optimizer engine (see  
     16        below) including rules of thumb on how and when to choose a given 
     17        optimizer and what the parameter do. 
     18    - The optimizer package has been completely replaced.  The new optimizer 
     19      still defaults to the standard Levenberg-Marquardt algorithm.  However 4 
     20      other optimizers are now available. Each starts with a set of default 
     21      parameters which can be tuned.  The DREAM optimizer takes the longest but 
     22      is the most powerful and yields rich information including full parameter 
     23      correlation and uncertainty plots.  A results panel has been added to 
     24      accommodate this.  The five optimizers are: 
     25      - A Levenberg-Marquardt optimizer 
     26      - A Quasi-Newton BFGS optimizer 
     27      - A Nelder-Mead Simplex optimizer 
     28      - A Differential Evolution optimizer 
     29      - A Monte Carlo optimizer DREAM optimizer  
     30    - Several new models added (what are they) 
     31    - Infrastructure to allow SESANS data to bit fit with models in a future 
     32      release was added and can currently be used from command line with some 
     33      caveats. 
     34    - A number of bugs were fixed including a thread crashing issue and a 
     35      incorrect resolution slit smearing. 
     36    - Implemented much more robust error logging to better enable much easier 
     37      debugging in general and particularly debugging an issue reported by 
     38      SasView user. 
     39    - A number of infrastructure tasks under the hood to enhance maintainability 
     40      - Upgrade from Wx 2.9 to 3.0.2 which allows several new features but 
     41        required significant other rework as well. 
     42      - Fully implemented Sphinx to the build process to produce both better 
     43        user documentation and developer documentation. 
     44      - Restructuring of code base to more unified nomenclature and structure 
     45        so that source installation tree more closely matches the installer 
     46        version tree. 
     47      - Code cleanup (an ongoing task)  
     48      - Migration of repository to github simplifying contributions from 
     49        non-project personnel through pull requests 
     50 
     51 
     52    - New in Version 3.0.0 
     53      - The GUI look and feel has been refactored to be more familiar for 
     54        Windows users by using MDI frames. Graph windows are also now free- 
     55        floating. 
     56      - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel, 
     57        RectangularPrismModel, RectangularHollowPrismModel and  
     58        RectangularHollowPrismInfThinWallsModel. 
     59      - The data loader now supports ILL DAT data files and reads the full meta  
     60        information from canSAS file formats. 
     61      - Redefined convention for specifying angular parameters for anisotropic 
     62        models. 
     63      - A number of minor features have been added such as permitting a log  
     64        distribution of points when using a model to simulate data, and the  
     65        addition of a Kratky plot option to the linear plots. 
     66      - A number of bugs have also been fixed. 
     67      - Save Project and Save Analysis now work more reliably. 
     68      - BETA: Magnetic contrast supporting full polarization analysis has been  
     69            implemented for some spherical and cylindrical models. 
     70      - BETA: Two new tools have been added: 
    2271            * A generic scattering calculator which takes an atomic, magnetic or  
    2372              SLD distribution in space and generates the appropriate 2D  
     
    2877            * An image viewer/converter for data in image format; this reads in  
    2978              an image file and will attempt to convert the image pixels to  
    30               data. Supported formats include: TIFF, TIF, PNG, BMP, JPG 
     79              data. Supported formats include: TIFF, TIF, PNG, BMP, JPG. 
    3180 
    3281    - New in Version 2.2.1 
     
    180229    2.1- System Requirements: 
    181230        - Python version >= 2.5 and < 3.0 should be running on the system 
    182         - We currently use Python 2.6 
     231        - We currently use Python 2.7 
    183232 
    184233    2.2- Installing from source: 
    185         - Get the code from sourceforge at https://svn.code.sf.net/p/sasview/code/ 
    186           for trunk end with code/trunk for a this release version end in  
    187           code/releases/sasview-3.0.0 
     234        - Get the code from sourceforge at https://github.com/SasView/sasview.git 
     235          for this release version use: https://github.com/SasView/sasview/releases 
    188236            - run 'python setup.py install' under the 'sasview-x.x.x' folder 
    189237            - run 'python sasview.py' under the 'sasview' folder. 
    190         - The following modules are required (version numbers are what are used in the release build): 
    191             - wxPython 2.8.12.1 (NOTE: do NOT use version 2.9) 
    192             - matplotlib 1.1.0 
    193             - SciPy 0.10.1 (NOTE: Mac build uses 0.10.0) 
    194             - pisa 3.0.27 (DO NOT USE ver 3.0.33 on windows: it will not work!) 
    195             - setuptools 0.6c11 
    196  
    197             (The following three are easily installed using easy_install) 
    198             - lxml 2.3.0.0 (NOTE: Mac build uses 3.1.0.0) 
    199             - numpy 1.6.1 (NOTE: Mac build uses version 1.6.2) 
    200             - periodictable 1.3.0 
     238        - The following modules are required (version numbers are what are used 
     239          in the windows release build): 
     240        - Common Packages 
     241          - reportlab 3.1.44 
     242          - lxml 3.4.4.0 (MAC 3.4.2.0) 
     243          - PIL 1.1.7 
     244          - xhtml2pdf 3.0.33 (MAC = not installed on build server) 
     245          - unittest-xml-reporting 1.12.0 (MAC 1.10.0) 
     246          - matplotlib Version Installed: 1.4.3 (MAC 1.1.1) 
     247          - bumps Version Installed: 0.7.5.6 
     248          - scipy Version Installed: 0.16.0b2 (MAC 0.11.0) 
     249          - periodictable Version Installed: 1.4.1 
     250          - setuptools Version Installed: 7.0 (MAC 12.0.5) 
     251          - sphinx Version Installed: 1.3.1 (MAC 1.3b2) 
     252          - pyparsing Version Installed: 2.0.3 
     253          - numpy Version Installed: 1.9.2 (MAC 1.6.2) 
     254          - html5lib Version Installed: 0.99999 
     255          - wx Version Installed: 3.0.2.0 
     256           
     257 
     258        - Windows Specific Packages: 
     259          - pywin 219 
     260          - py2exe 0.6.9 
     261          - comtypes 1.1.1 
     262          - MinGW w/ gcc version 4.6.1 (WIN) 
     263          - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008  
     264              re-distributable) 
     265          - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributalbe 
    201266             
    202             (The following are additional dependencies for Mac) 
    203             - py2app 0.7.1 
    204              
    205             (The following are additional dependencies for Windows) 
    206             - comtypes 0.6.2 (for PDF support on windows systems) 
    207             - pywin32 build 217 (to read ms office) 
    208             - html5lib 0.95-dev 
    209             - reportlab 2.5 (NOTE: Mab build uses 2.6 though should not be needed) 
    210             - pyparsing 1.5.5 (required for periodictable and bundling 
    211               NOTE: is ALSO present on Mac Build) 
    212             - PIL 1.1.7 (Python Image Library - NOTE: is also present on Mac build) 
    213             - py2exe 0.6.9 (WIN) 
    214             - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008  
    215               re-distributable) 
    216             - subversion -1.6.0 (<1.6.1) 
    217             - MinGW w/ gcc version 4.6.1 (WIN) 
    218             - Innosetup (WIN - isetup 5.4.2-unicode). 
    219              
    220             (On Windows, the following site has all the dependencies nicely packaged) 
    221             http://www.lfd.uci.edu/~gohlke/pythonlibs/ 
     267        - MAC Specifci Packages: 
     268          - py2app 0.7.1 
     269        - Windows build dependencies can be set up using anaconda. Instructions 
     270          can be found at http://trac.sasview.org/wiki/AnacondaSetup 
    222271 
    223272 
     
    225274 
    226275    3.1- All systems: 
    227         - very old computers may not be able to run 
    228         - polydispersity on multiple parameters included in a simultaneous/ 
     276        - Tutorial has not yet been updated and is somewhat out of date 
     277        - Very old computers may not be able to run 
     278        - Polydispersity on multiple parameters included in a simultaneous/ 
    229279          constrained fit will likely not be correct 
     280        - Constrained/simultaneous fit page does not have a stop button 
     281        - Constrained/simultaneous fit do not accept min/max limits 
    230282        - Save project does not store the state of all the windows 
    231283        - Loading projects can be very slow 
    232284        - Save Project only works once a data set has been associated with 
    233285          a model.  Error is reported on status bar. 
     286        - There is a numerical precision problem with the multishell model when 
     287          the iner radius gets large enough (ticket #288) 
     288        - The angular distribution angles are not clearly defined and may in 
     289          some cases lead to incorrect calculations(ticket #332) 
     290           
    234291 
    235292    3.2- Windows: 
     
    244301                 
    245302    3.4- Linux: 
    246         - None 
     303        - Not well tested 
    247304 
    2483054- SasView website 
Note: See TracChangeset for help on using the changeset viewer.