[fa00944] | 1 | Release Notes |
---|
| 2 | ============= |
---|
[3dc977c] | 3 | |
---|
[0e18d07] | 4 | SasView 3.0.0 |
---|
| 5 | |
---|
[7a67f4da] | 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 |
---|
[69ef722] | 8 | - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel, |
---|
[7a67f4da] | 9 | RectangularPrismModel, RectangularHollowPrismModel and |
---|
| 10 | RectangularHollowPrismInfThinWallsModel |
---|
| 11 | - The data loader now supports ILL DAT data files and reads the full meta |
---|
[6b20c4e] | 12 | information from canSAS file formats |
---|
[d497189] | 13 | - Redefined convention for specifying angular parameters for anisotropic models |
---|
[7a67f4da] | 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 |
---|
[eb9fc6d] | 17 | - A number of bugs have also been fixed |
---|
| 18 | - Save Project and Save Analysis now work more reliably |
---|
[7a67f4da] | 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: |
---|
| 22 | * A generic scattering calculator which takes an atomic, magnetic or |
---|
| 23 | SLD distribution in space and generates the appropriate 2D |
---|
| 24 | scattering pattern. In some cases the orientationally averaged |
---|
| 25 | (powder) 1D scattering can also be computed. Supported formats |
---|
| 26 | include: SLD or text, PDB, and OMF magnetic moment distribution |
---|
| 27 | file. |
---|
| 28 | * An image viewer/converter for data in image format; this reads in |
---|
| 29 | an image file and will attempt to convert the image pixels to |
---|
| 30 | data. Supported formats include: TIFF, TIF, PNG, BMP, JPG |
---|
[6b20c4e] | 31 | |
---|
| 32 | - New in Version 2.2.1 |
---|
| 33 | - Minor patch to support CanSAS XML v1.1 file format |
---|
[eb9fc6d] | 34 | - Added DataInfo for data in the DataExplorer and plots |
---|
| 35 | - Added Maximize/Restore button in the title bar of the graphs |
---|
| 36 | - Added a hide button in the toolbar of the graph panel |
---|
| 37 | - The 'x' button now deletes a graph |
---|
| 38 | - Edit SUM Model from the menubar can now generate and save more than one sum model |
---|
| 39 | - Reports can now be saved in pdf format on WIN and MAC |
---|
| 40 | - Made significant improvements to the batch/grid panel and fixed several bugs |
---|
| 41 | - Fixed a number of other minor bugs |
---|
[6b20c4e] | 42 | |
---|
| 43 | - New in Version 2.2.0 |
---|
| 44 | - Application name changed to SasView |
---|
| 45 | - New fully customizable Category Manager added for better management of |
---|
| 46 | increasing number of models |
---|
| 47 | - Improved the Grid Window functionality in the batch fitting mode |
---|
| 48 | - Added a simpler Graph/Plot modification interface |
---|
| 49 | - Added a new 'Data Operation' tool for addition, subtraction, multiplication, |
---|
| 50 | division, of two data sets. |
---|
| 51 | - The 'Sum Model' editor was extended and renamed 'Summation and Multiplication' |
---|
| 52 | editor |
---|
| 53 | - Added more plot symbols options for 1d plots |
---|
| 54 | - Added improved trapping of compiling errors to the 'New model editor' |
---|
| 55 | - 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 |
---|
| 56 | - Added more models |
---|
| 57 | |
---|
| 58 | - Feature set from Previous Versions: |
---|
| 59 | |
---|
| 60 | - Perspectives Available |
---|
| 61 | - Invariant calculator: Calculates the invariant, volume fraction, and |
---|
| 62 | specific surface area. |
---|
| 63 | - P(r) inversion calculator: Indirect Fourier transformation method. |
---|
| 64 | - Fitting: the tool used for modeling and fitting 1D and 2D data to |
---|
| 65 | analytical model functions |
---|
| 66 | - Tools: provides a number of useful supplementary tools such as SLD |
---|
| 67 | calculation |
---|
| 68 | |
---|
| 69 | - Fitting |
---|
| 70 | - Includes a large number of model functions, both form factors and structure factors. |
---|
| 71 | - Support P(Q)*S(Q) for form factors that flag they can be so multiplied. |
---|
| 72 | - Supports Gaussian, lognormal, Shulz, rectangular and custom distribution |
---|
| 73 | functions for models that need to include polydispersity or for orientational |
---|
| 74 | distributions if appropriate. |
---|
| 75 | - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform |
---|
| 76 | distribution of orientations of a given axis leading to modeling and fitting |
---|
| 77 | capabilities of non azimuthaly symmetric data. |
---|
| 78 | - User can choose to weight fits or not. If using weights, the user can choose |
---|
| 79 | the error bar on each point if provided in the file, the square root |
---|
| 80 | of the intensity or the intensity itself. |
---|
| 81 | - Instrumental resolution smearing of model or fits is provided with several |
---|
| 82 | options: read the resolution/point fromt he file. Input a pinhole resolution |
---|
| 83 | or a slit resolution. |
---|
| 84 | - Users can define the Qrange (Qmin and Qmax) for both 1D and 2D data for |
---|
| 85 | fitting and modeling, but not graphically. The range can be reset to the |
---|
| 86 | defaults (limits of q in data set for a fit) with the reset button. |
---|
| 87 | - A mask can be applied to 2D calculation and fitting. |
---|
| 88 | - Normalized residual plots are provided with every fit. |
---|
| 89 | - Model function help available through detail button or from the fitting panel. |
---|
| 90 | - Simultaneous/(advanced)constrained fitting allows for fitting a single |
---|
| 91 | data set or several different sets simultaneously with the application |
---|
| 92 | of advanced constraints relating fit parameters to functions of other |
---|
| 93 | parameters (including from a different set). For example thickness of |
---|
| 94 | shell = sin(30) times the length. |
---|
| 95 | - Models that are the sum of two other models can be easily generated through the |
---|
| 96 | SUM Model menubar item. |
---|
| 97 | - New Python models can be added on the fly by creating an appropriate Python |
---|
| 98 | file in the model plugin directory. Two tools are provided to help: |
---|
| 99 | An easy to use custom model editor allows the quick generation of new Python |
---|
| 100 | models by supplying only the parameters and their default value (box 1) |
---|
| 101 | and the mathematical function of the model (box 2) and generating the |
---|
| 102 | necessary *.py file. A separate advanced model editor provides a full Python |
---|
| 103 | file editor. Either way once saved the model becomes immediately available |
---|
| 104 | to the application. |
---|
| 105 | - A batch fittng capability allows for the analysis of a series of data sets to |
---|
| 106 | a sinble model and provides the results in a tabular form suitable for saving |
---|
| 107 | or plotting the evolution of the fit parameters with error bars (from within |
---|
| 108 | the application). |
---|
| 109 | |
---|
| 110 | - Tools |
---|
| 111 | - A scattering length density calculator,including some X-ray information |
---|
| 112 | is provided. |
---|
| 113 | - A density to vol. fraction converter is provided |
---|
| 114 | - In application access to a Python shell/editor (PyCrust) is provided |
---|
| 115 | - An instrument resolution calculator, including possible gravitational and |
---|
| 116 | TOF effects is provided |
---|
| 117 | - A slit size calculator optimized for Anton Paar Saxess is provided. |
---|
| 118 | - A kiessig fringe thickness calculator is provided |
---|
| 119 | - Plots and plot management |
---|
| 120 | - A 3D graphing option (for 2d data/results) is provided with the view |
---|
| 121 | controlled by the mouse |
---|
| 122 | - 2D plots are shown with an intensity color bar. 2D Color map can be user |
---|
| 123 | adjusted. |
---|
| 124 | - Supports output of plot to a variety of graphic formats. Supported formats |
---|
| 125 | include: png, eps, emf, jpg/jpeg, pdf, ps, tif/tiff, rawRGBbitmap(raw, rgba), |
---|
| 126 | and scalable vector graphic (svg/svgz) |
---|
| 127 | - Supports ouput of data in plot (1 or 2D) to limited data formats |
---|
| 128 | - Multiple data sets can be loaded into a single graph for viewing (but a fit |
---|
| 129 | plot can currently only have a single plot). |
---|
| 130 | - Extensive context sensitive plot/fitting/manipulation options are available |
---|
| 131 | through a right mouse click pop-up menu on plots. |
---|
| 132 | - Data management |
---|
| 133 | - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data |
---|
| 134 | via plug-in mechanism which can easily allow other readers as appropriate. |
---|
| 135 | - 2D data is expected in Q space but for historical reasons accepts the |
---|
| 136 | NIST 2D raw pixel format and will do conversion internally. |
---|
| 137 | - The full data and metadata available to SasView is viewable in ASCII via |
---|
| 138 | right clicking on a data set and choosing Data Info in the DataExplorer |
---|
| 139 | or on the plots |
---|
| 140 | - Supports loading a single file, multiple files, or a whole folder |
---|
| 141 | - An optional Data Explorer is provided (default) which simplifies managing, |
---|
| 142 | plotting, deleting, or setup for computation. Most functions however do |
---|
| 143 | not require access to the explorer/manager and can be accessed through |
---|
| 144 | right click menus and the toolbar. The data explorer can be re-started |
---|
| 145 | from the menu bar. |
---|
| 146 | - Data manipulation |
---|
| 147 | - Support various 2D averaging methods : Circular, sectors, annular, |
---|
| 148 | boxsum, boxQx and boxQy. |
---|
| 149 | - A 2D data maks editor is provided |
---|
| 150 | - 2D mask can be applied to the circular averaging. |
---|
| 151 | - Miscellaneous features |
---|
| 152 | - limited reports can be generated in pdf format |
---|
| 153 | - Provides multiprocessor support(Windows only) |
---|
| 154 | - Limited startup customization currently includes default startup |
---|
| 155 | data folder and choice of default starting with data manager |
---|
| 156 | - Limited support for saving(opening) a SasView project or a SasView analysis |
---|
| 157 | (subproject) is provided. |
---|
| 158 | - SasView can be launched and loaded with a file of interesty by double-clicking |
---|
| 159 | on that file (recognized extension) |
---|
| 160 | - A data file or data folder can be passed to SasView when launched from |
---|
| 161 | the command line. |
---|
| 162 | - Limited bookmarking capability to later recall the results of a fit calculation |
---|
| 163 | is provided. |
---|
| 164 | - Extensive help is provided through context sensitive mouse roll-over, |
---|
| 165 | information bar (at the bottom of the panel), the console menu, and |
---|
| 166 | access to the help files in several different ways. |
---|
[0e18d07] | 167 | |
---|
[3dc977c] | 168 | |
---|
[fa00944] | 169 | |
---|
| 170 | 2- Downloading and Installing |
---|
[afea8fe] | 171 | |
---|
[6b20c4e] | 172 | *** Note 1: Much more information is available at www.sasview.org under links. |
---|
| 173 | Look in the 'For Developers' section and particularly the wiki at |
---|
| 174 | www.sasview.org/trac/wiki. |
---|
| 175 | *** Note 2: If you have EXE or ZIP SasView installer, you won't need any of |
---|
[099c355] | 176 | the following. However it is highly recommended that any |
---|
| 177 | previous versions be un-installed prior to installing the |
---|
| 178 | new version. |
---|
[6b20c4e] | 179 | |
---|
| 180 | 2.1- System Requirements: |
---|
| 181 | - Python version >= 2.5 and < 3.0 should be running on the system |
---|
| 182 | - We currently use Python 2.6 |
---|
| 183 | |
---|
| 184 | 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 |
---|
| 188 | - run 'python setup.py install' under the 'sasview-x.x.x' folder |
---|
| 189 | - 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 |
---|
| 201 | |
---|
| 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/ |
---|
[fa00944] | 222 | |
---|
| 223 | |
---|
| 224 | 3- Known Issues |
---|
| 225 | |
---|
[6b20c4e] | 226 | 3.1- All systems: |
---|
| 227 | - very old computers may not be able to run |
---|
| 228 | - polydispersity on multiple parameters included in a simultaneous/ |
---|
| 229 | constrained fit will likely not be correct |
---|
| 230 | - Save project does not store the state of all the windows |
---|
[099c355] | 231 | - Loading projects can be very slow |
---|
| 232 | - Save Project only works once a data set has been associated with |
---|
| 233 | a model. Error is reported on status bar. |
---|
[fa00944] | 234 | |
---|
[6b20c4e] | 235 | 3.2- Windows: |
---|
[099c355] | 236 | - If installed to same directory as old version without first removing |
---|
| 237 | the old version, the old desktop icon will remain but point to the |
---|
| 238 | new exe version. Likewise all the start menu folders and items will |
---|
| 239 | have the old name even though pointing to the new version. Usually |
---|
| 240 | safest to uninstall old version prior to installing new version anyway. |
---|
[fa00944] | 241 | |
---|
[6b20c4e] | 242 | 3.3- MAC: |
---|
| 243 | - multiprocessing does not currently work on MAC OS |
---|
[fa00944] | 244 | |
---|
[6b20c4e] | 245 | 3.4- Linux: |
---|
| 246 | - None |
---|
[fa00944] | 247 | |
---|
[6b20c4e] | 248 | 4- SasView website |
---|
[fa00944] | 249 | |
---|
[6b20c4e] | 250 | - www.sasview.org. This main project site is the gateway to all |
---|
| 251 | information about the sasview project. It includes information |
---|
| 252 | about the project, a FAQ page and links to all developer and user |
---|
| 253 | information, tools and resources. |
---|
[fa00944] | 254 | |
---|
| 255 | 5- Frequently Asked Questions |
---|
| 256 | |
---|
[6b20c4e] | 257 | - www.sasview.org/faq.html |
---|
[fa00944] | 258 | |
---|
| 259 | 6- Installer download website |
---|
[3dc977c] | 260 | |
---|
[6b20c4e] | 261 | - Latest release Version |
---|
| 262 | - http://sourceforge.net/projects/sasview/files/ |
---|
| 263 | - Latest developer Windows or Ubuntu build |
---|
| 264 | - http://build.sasview.org/ |
---|
| 265 | - Latest developer Mac OS build |
---|
| 266 | - http://download.mantidproject.org/jenkins/view/All/job/sasview_snowleopard_32bit/ |
---|
| 267 | |
---|
| 268 | |
---|