source: sasview/sansview/README.txt @ 79d5b6c

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 79d5b6c was 10be315, checked in by Jae Cho <jhjcho@…>, 12 years ago

added new feature list: readme

  • Property mode set to 100644
File size: 7.2 KB
Line 
1Release Notes
2=============
3
4SasView 3.0.0
5
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
9    - 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.
96
97
982- Downloading and Installing
99       
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/
140
141
1423- Known Issues
143
144        3.1- All systems:
145                - very old computers may not be able to run
146
147        3.2- Windows:
148                - None
149               
150        3.3- MAC:
151                - None
152               
153        3.4- Linux:
154                - None
155
1564- Troubleshooting
157
158        - None
159
1605- Frequently Asked Questions
161
162        - None
163
1646- Installer download website
165
166        - http://sourceforge.net/projects/sansviewproject/files/
Note: See TracBrowser for help on using the repository browser.