| 1 | Release Notes |
|---|
| 2 | ============= |
|---|
| 3 | |
|---|
| 4 | 1- Features |
|---|
| 5 | =========== |
|---|
| 6 | - New in Version 4.1.1 |
|---|
| 7 | -------------------- |
|---|
| 8 | This point release is a bug-fix release addressing a few small issues related |
|---|
| 9 | to documentation, test data being bundled, reading canSAS1D xml files and saving |
|---|
| 10 | projects. |
|---|
| 11 | |
|---|
| 12 | It is recommended that all users upgrade to this version |
|---|
| 13 | |
|---|
| 14 | - New in Version 4.1.0 |
|---|
| 15 | ------------------ |
|---|
| 16 | This incremental release brings a series of new features and improvements, |
|---|
| 17 | and a host of bug fixes. Of particular note are: |
|---|
| 18 | |
|---|
| 19 | - Correlation Function Analysis (Corfunc) |
|---|
| 20 | This performs a correlation function analysis of one-dimensional SAXS/SANS data, |
|---|
| 21 | or generates a model-independent volume fraction profile from the SANS from an |
|---|
| 22 | adsorbed polymer/surfactant layer. |
|---|
| 23 | |
|---|
| 24 | A correlation function may be interpreted in terms of an imaginary rod moving |
|---|
| 25 | through the structure of the material. Î1D(R) is the probability that a rod of |
|---|
| 26 | length R moving through the material has equal electron/neutron scattering |
|---|
| 27 | length density at either end. Hence a frequently occurring spacing within a |
|---|
| 28 | structure manifests itself as a peak. |
|---|
| 29 | |
|---|
| 30 | A volume fraction profile \Phi(z) describes how the density of polymer |
|---|
| 31 | segments/surfactant molecules varies with distance from an (assumed locally flat) |
|---|
| 32 | interface. |
|---|
| 33 | |
|---|
| 34 | - Fitting of SESANS Data |
|---|
| 35 | Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will |
|---|
| 36 | be plotted against the correct axes and models will automatically perform a Hankel |
|---|
| 37 | transform in order to calculate SESANS from a SANS model. |
|---|
| 38 | |
|---|
| 39 | - Documentation |
|---|
| 40 | The documentation has undergone significant checking and updating. |
|---|
| 41 | |
|---|
| 42 | - Improvements |
|---|
| 43 | - Correlation function (corfunc) analysis of 1D SAS data added from CCP13 |
|---|
| 44 | - File converter tool for multi-file single column data sets |
|---|
| 45 | - SESANS data loading and direct fitting using the Hankel transformation |
|---|
| 46 | - Saving and loading of simultaneous and constrained fits now supported |
|---|
| 47 | - Save states from SasView v3.x.y now loaded using sasmodel model names |
|---|
| 48 | - Saving and loading of projects with 2D fits now supported |
|---|
| 49 | - Loading a project removes all existing data, fits, and plots |
|---|
| 50 | - Structure factor and form factor can be plotted independently |
|---|
| 51 | - OpenCL is disabled by default and can be enabled through a fit menu |
|---|
| 52 | - Data and theory fields are now independently expandable |
|---|
| 53 | - Bug Fixes |
|---|
| 54 | - Fixes #667: Models computed multiple times on parameters changes |
|---|
| 55 | - Fixes #673: Custom models override built in models of same name |
|---|
| 56 | - Fixes #678: Hard crash when running complex models on GPU |
|---|
| 57 | - Fixes $774: Old style plugin models unloadable |
|---|
| 58 | - Fixes #789: stacked disk scale doesn't match cylinder model |
|---|
| 59 | - Fixes #792: core_shell_fractal uses wrong effective radius |
|---|
| 60 | - Fixes #800: Plot range reset on plot redraws |
|---|
| 61 | - Fixes #811 and #825: 2D smearing broken |
|---|
| 62 | - Fixes #815: Integer model parameter handling |
|---|
| 63 | - Fixes #824: Cannot apply sector averaging when no detector data present |
|---|
| 64 | - Fixes #830: Cansas HDF5 reader fully compliant with NXCanSAS v1.0 format |
|---|
| 65 | - Fixes #835: Fractal model breaks with negative Q values |
|---|
| 66 | - Fixes #843: Multilayer vesicle does not define effective radius |
|---|
| 67 | - Fixes #858: Hayter MSA S(Q) returns errors |
|---|
| 68 | - Numerous grammatical and contexual errors in documention |
|---|
| 69 | |
|---|
| 70 | |
|---|
| 71 | - New in Version 4.0.1 |
|---|
| 72 | ------------------ |
|---|
| 73 | This release fixes the critical bug #750 in P(Q)*S(Q). Most damaging |
|---|
| 74 | it appears that the background term was being added to S(Q) prior to |
|---|
| 75 | multiplication by P(Q). |
|---|
| 76 | |
|---|
| 77 | |
|---|
| 78 | - New in Version 4.0 |
|---|
| 79 | ------------------ |
|---|
| 80 | This release fixes the various bugs found during the alpha and beta testing |
|---|
| 81 | - Improvements |
|---|
| 82 | - Support for reading data files from Anton Paar Saxess instruments |
|---|
| 83 | - Adds documentation on how to write custom models in the new framework |
|---|
| 84 | - Bug Fixes |
|---|
| 85 | - Fixes bug #604 Pringle model questions |
|---|
| 86 | - Fixes bug #472 Reparameterize Teubner-Strey |
|---|
| 87 | - Fixes bug #530 Numerical instabilities in Teubner Strey model |
|---|
| 88 | - Fixes bug #658 ASCII reader very broken |
|---|
| 89 | |
|---|
| 90 | |
|---|
| 91 | - New in Version 4.0 beta 1 |
|---|
| 92 | -------------------- |
|---|
| 93 | This beta adds support for the magnetic and multilevel models of 3.1.2 |
|---|
| 94 | and along with a host of bug fixes found in the alpha. |
|---|
| 95 | |
|---|
| 96 | - Model package changes and improvements |
|---|
| 97 | - All 3.1.2 models now available in new interface |
|---|
| 98 | - Old custom models should now still work |
|---|
| 99 | - '''NOTE:''' These will be deprecated in a future version. Old |
|---|
| 100 | custom models should be converted to the new model format which |
|---|
| 101 | is now the same as the built in models and offers much better |
|---|
| 102 | support. |
|---|
| 103 | - Custom model editor now creates new style models |
|---|
| 104 | - Custom model editor supports better error checking |
|---|
| 105 | - Documentation improvements |
|---|
| 106 | - Continued general cleanup |
|---|
| 107 | - Other improvements/additions |
|---|
| 108 | - Support for new canSAS 2D data files added |
|---|
| 109 | - Plot axes range can now be set manually as well as by zooming |
|---|
| 110 | - Plot annotations can now be moved around after being placed on plot. |
|---|
| 111 | - The active optimizer is now listed on the top of the fit panel. |
|---|
| 112 | - Linear fits now update qmin and max when the x scale limits are |
|---|
| 113 | changed. Also the plot range no longer resets after a fit. |
|---|
| 114 | - Bug fixes |
|---|
| 115 | - Fixes bug #511 Errors in linearized fits and clean up of interface |
|---|
| 116 | including Kratky representation |
|---|
| 117 | - Fixes bug #186 Data operation Tool now executes when something is |
|---|
| 118 | entered in the text box and does not wait for the user to hit enter |
|---|
| 119 | - Fixes bug #459 plot context menu bug |
|---|
| 120 | - Fixes bug #559 copy to clipboard in graph menu broken |
|---|
| 121 | - Fixes bug #466 cannot remove a linear fit from graph |
|---|
| 122 | - Numerous bugs introduced in the alpha |
|---|
| 123 | |
|---|
| 124 | |
|---|
| 125 | |
|---|
| 126 | - New in Version 4.0.0-alpha |
|---|
| 127 | -------------------- |
|---|
| 128 | This alpha release brings a major overhaul of the model system. The new model |
|---|
| 129 | package allows rapid integration of custom models and access to polydispersity |
|---|
| 130 | without requiring a compiler. |
|---|
| 131 | |
|---|
| 132 | - Model package changes and improvements |
|---|
| 133 | - Model interface moved to independent sasmodels package. |
|---|
| 134 | - Most models converted to new interface. |
|---|
| 135 | - Allows rapid integration of user-written models. |
|---|
| 136 | - OpenCL GPU utilization for faster fitting. |
|---|
| 137 | - Improved numerical integration of Bessel functions. |
|---|
| 138 | - SESANS integration and implementation |
|---|
| 139 | - Scripting interface added for analysis of SESANS data. |
|---|
| 140 | - Hankel transformation now accepts finite acceptance angles. |
|---|
| 141 | - 2D cosine transformation added for TOF SESANS analysis. |
|---|
| 142 | - Documentation improvements |
|---|
| 143 | - The documentation tree was restructured for a better end user experience. |
|---|
| 144 | - The documentation for each model was revamped and verified by at least |
|---|
| 145 | two people following the conversion of the model. |
|---|
| 146 | - Theoretical 1D (and 2D if applicable) scattering curves are auto-generated |
|---|
| 147 | and added to the model documentation for each model. |
|---|
| 148 | - Separation of GUI and calculations for future GUI enhancements |
|---|
| 149 | - Bug fixes |
|---|
| 150 | - Fixes bug #411 No stop button on simultaneous fit page |
|---|
| 151 | - Fixes bug #410 Error with raspberry model |
|---|
| 152 | - Fixes bug #364 Possible inconsistency in Poly_GausCoil model |
|---|
| 153 | - Fixes bug #439 Hayter Penfold MSA code needs checking |
|---|
| 154 | - Fixes bug #484 lammellerPC is precision limited |
|---|
| 155 | - Fixes bug #498 $HOME/.matplotlib conflicts |
|---|
| 156 | - Fixes bug #348 Control order in which fit parameters appear in the gui |
|---|
| 157 | - Fixes bug #456 Provide DREAM Results Panel with something to identify |
|---|
| 158 | data and age of results |
|---|
| 159 | - Fixes bug #556 Build script improvements for developers |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | - New in Version 3.1.2 |
|---|
| 164 | -------------------- |
|---|
| 165 | This release is a major stability improvement, having fixed a serious bug |
|---|
| 166 | that came to light since release 3.1.1. All users should upgrade. |
|---|
| 167 | |
|---|
| 168 | - Fixes bug #468 broken remove constraint buttons in |
|---|
| 169 | simultaneous/constrained fitting panel |
|---|
| 170 | - Fixes bug #474 resulting from changes in 3.1.1 that had |
|---|
| 171 | introduced an error in the high-Q of slit-smeared models. |
|---|
| 172 | - Fixes bug #478 which would cause wx to run out of IDs and result |
|---|
| 173 | in SasView crashing even if left alone. |
|---|
| 174 | - Fixes bug #479 missing help button on simultaneous/constrained fit page |
|---|
| 175 | - Fixes bug #480 GUI resizing issues on simultaneous fit page |
|---|
| 176 | - Fixes bug #486 broken Report Results |
|---|
| 177 | - Fixes bug #488 redraw issues in fit page |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | - New in Version 3.1.1 |
|---|
| 182 | -------------------- |
|---|
| 183 | - Fixes bug #457 that prevented SasView from starting if the user was not |
|---|
| 184 | connected to the internet, or was behind a proxy server. |
|---|
| 185 | |
|---|
| 186 | - New in Version 3.1.0 |
|---|
| 187 | -------------------- |
|---|
| 188 | - The documentation/help has had a complete overhaul including: |
|---|
| 189 | - A completely new presentation interface (Sphinx). |
|---|
| 190 | - Proof reading! |
|---|
| 191 | - Updating for latest features. |
|---|
| 192 | - A Help (or sometimes ?) button has been added to every panel, and some |
|---|
| 193 | sub panels if appropriate, linking to the appropriate section in the |
|---|
| 194 | documentation. |
|---|
| 195 | - The model help has been split so that the Details button now brings up |
|---|
| 196 | a very short pop-up giving the equation being used while HELP goes to |
|---|
| 197 | the section in the full documentation describing the model. |
|---|
| 198 | - Extensive help has also been added for the new optimizer engine (see |
|---|
| 199 | below) including rules of thumb on how and when to choose a given |
|---|
| 200 | optimizer and what the parameters do. |
|---|
| 201 | - The optimizer engine has been completely replaced. The new optimizer |
|---|
| 202 | still defaults to the standard Levenberg-Marquardt algorithm. However 4 |
|---|
| 203 | other optimizers are now also available. Each starts with a set of default |
|---|
| 204 | parameters which can be tuned. The DREAM optimizer takes the longest but |
|---|
| 205 | is the most powerful and yields rich information including full parameter |
|---|
| 206 | correlation and uncertainty plots. A results panel has been added to |
|---|
| 207 | accommodate this. |
|---|
| 208 | - The five new optimizers are: |
|---|
| 209 | - A Levenberg-Marquardt optimizer |
|---|
| 210 | - A Quasi-Newton BFGS optimizer |
|---|
| 211 | - A Nelder-Mead Simplex optimizer |
|---|
| 212 | - A Differential Evolution optimizer |
|---|
| 213 | - A Monte Carlo optimizer (DREAM) |
|---|
| 214 | - New models were added: |
|---|
| 215 | - MicelleSphCoreModel (currently residing in the Uncategorized category) |
|---|
| 216 | - Existing models were updated: |
|---|
| 217 | - LamellarPS (bug in polydispersity integration fixed) |
|---|
| 218 | - RectangularPrismModel |
|---|
| 219 | - RectangularHollowPrismModel |
|---|
| 220 | - RectangularHollowPrismInfThinWallsModel |
|---|
| 221 | - Infrastructure to allow SESANS data to be fit with models was added. This |
|---|
| 222 | will become available in a future release but can currently be used from |
|---|
| 223 | the command line with some caveats. |
|---|
| 224 | - A number of bugs were fixed including a thread crashing issue and an |
|---|
| 225 | incorrect slit smearing resolution calculation. |
|---|
| 226 | - Implemented much more robust error logging to enable much easier |
|---|
| 227 | debugging in general but particularly the debugging of issues reported by |
|---|
| 228 | SasView users. |
|---|
| 229 | - A number of infrastructure tasks under the hood to enhance maintainability |
|---|
| 230 | - Upgrade from Wx 2.8 to Wx 3.0.2 which allows several new features but |
|---|
| 231 | required significant additional rework as well. |
|---|
| 232 | - Fully implemented Sphinx to the build process to produce both better |
|---|
| 233 | user documentation and developer documentation. |
|---|
| 234 | - Restructuring of the code base to more unified nomenclature and structure |
|---|
| 235 | so that the source installation tree more closely matches the installer |
|---|
| 236 | version tree. |
|---|
| 237 | - Code cleanup (an ongoing task) . |
|---|
| 238 | - Migration of the repository to github simplifying contributions from |
|---|
| 239 | non-project personnel through pull requests. |
|---|
| 240 | |
|---|
| 241 | - New in Version 3.0.0 |
|---|
| 242 | -------------------- |
|---|
| 243 | - The GUI look and feel has been refactored to be more familiar for |
|---|
| 244 | Windows users by using MDI frames. Graph windows are also now free- |
|---|
| 245 | floating. |
|---|
| 246 | - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel, |
|---|
| 247 | RectangularPrismModel, RectangularHollowPrismModel and |
|---|
| 248 | RectangularHollowPrismInfThinWallsModel. |
|---|
| 249 | - The data loader now supports ILL DAT data files and reads the full meta |
|---|
| 250 | information from canSAS file formats. |
|---|
| 251 | - Redefined convention for specifying angular parameters for anisotropic |
|---|
| 252 | models. |
|---|
| 253 | - A number of minor features have been added such as permitting a log |
|---|
| 254 | distribution of points when using a model to simulate data, and the |
|---|
| 255 | addition of a Kratky plot option to the linear plots. |
|---|
| 256 | - A number of bugs have also been fixed. |
|---|
| 257 | - Save Project and Save Analysis now work more reliably. |
|---|
| 258 | - BETA: Magnetic contrast supporting full polarization analysis has been |
|---|
| 259 | implemented for some spherical and cylindrical models. |
|---|
| 260 | - BETA: Two new tools have been added: |
|---|
| 261 | - A generic scattering calculator which takes an atomic, magnetic or |
|---|
| 262 | SLD distribution in space and generates the appropriate 2D |
|---|
| 263 | scattering pattern. In some cases the orientationally averaged |
|---|
| 264 | (powder) 1D scattering can also be computed. Supported formats |
|---|
| 265 | include: SLD or text, PDB, and OMF magnetic moment distribution |
|---|
| 266 | file. |
|---|
| 267 | - An image viewer/converter for data in image format; this reads in |
|---|
| 268 | an image file and will attempt to convert the image pixels to |
|---|
| 269 | data. Supported formats include: TIFF, TIF, PNG, BMP, JPG. |
|---|
| 270 | |
|---|
| 271 | - New in Version 2.2.1 |
|---|
| 272 | -------------------- |
|---|
| 273 | - Minor patch to support CanSAS XML v1.1 file format |
|---|
| 274 | - Added DataInfo for data in the DataExplorer and plots |
|---|
| 275 | - Added Maximize/Restore button in the title bar of the graphs |
|---|
| 276 | - Added a hide button in the toolbar of the graph panel |
|---|
| 277 | - The 'x' button now deletes a graph |
|---|
| 278 | - Edit SUM Model from the menubar can now generate and save more than one sum model |
|---|
| 279 | - Reports can now be saved in pdf format on WIN and MAC |
|---|
| 280 | - Made significant improvements to the batch/grid panel and fixed several bugs |
|---|
| 281 | - Fixed a number of other minor bugs |
|---|
| 282 | |
|---|
| 283 | - New in Version 2.2.0 |
|---|
| 284 | -------------------- |
|---|
| 285 | - Application name changed to SasView |
|---|
| 286 | - New fully customizable Category Manager added for better management of |
|---|
| 287 | increasing number of models |
|---|
| 288 | - Improved the Grid Window functionality in the batch fitting mode |
|---|
| 289 | - Added a simpler Graph/Plot modification interface |
|---|
| 290 | - Added a new 'Data Operation' tool for addition, subtraction, multiplication, |
|---|
| 291 | division, of two data sets. |
|---|
| 292 | - The 'Sum Model' editor was extended and renamed 'Summation and Multiplication' |
|---|
| 293 | editor |
|---|
| 294 | - Added more plot symbols options for 1d plots |
|---|
| 295 | - Added improved trapping of compiling errors to the 'New model editor' |
|---|
| 296 | - Added some intelligent outputs (e.g., Rg, background, or rod diameter |
|---|
| 297 | depending on the choice of axis scale of the plot) to the linear fits |
|---|
| 298 | - Added more models |
|---|
| 299 | |
|---|
| 300 | - Feature set from previous versions |
|---|
| 301 | ----------------------------------- |
|---|
| 302 | - Perspectives Available |
|---|
| 303 | - Invariant calculator: Calculates the invariant, volume fraction, and |
|---|
| 304 | specific surface area. |
|---|
| 305 | - P(r) inversion calculator: Indirect Fourier transformation method. |
|---|
| 306 | - Fitting: the tool used for modeling and fitting 1D and 2D data to |
|---|
| 307 | analytical model functions |
|---|
| 308 | - Tools: provides a number of useful supplementary tools such as SLD |
|---|
| 309 | calculation |
|---|
| 310 | |
|---|
| 311 | - Fitting |
|---|
| 312 | - Includes a large number of model functions, both form factors and structure factors. |
|---|
| 313 | - Support P(Q)*S(Q) for form factors that flag they can be so multiplied. |
|---|
| 314 | - Supports Gaussian, lognormal, Shulz, rectangular and custom distribution |
|---|
| 315 | functions for models that need to include polydispersity or for orientational |
|---|
| 316 | distributions if appropriate. |
|---|
| 317 | - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform |
|---|
| 318 | distribution of orientations of a given axis leading to modeling and fitting |
|---|
| 319 | capabilities of non azimuthaly symmetric data. |
|---|
| 320 | - User can choose to weight fits or not. If using weights, the user can choose |
|---|
| 321 | the error bar on each point if provided in the file, the square root |
|---|
| 322 | of the intensity or the intensity itself. |
|---|
| 323 | - Instrumental resolution smearing of model or fits is provided with several |
|---|
| 324 | options: read the resolution/point fromt he file. Input a pinhole resolution |
|---|
| 325 | or a slit resolution. |
|---|
| 326 | - Users can define the Qrange (Qmin and Qmax) for both 1D and 2D data for |
|---|
| 327 | fitting and modeling, but not graphically. The range can be reset to the |
|---|
| 328 | defaults (limits of q in data set for a fit) with the reset button. |
|---|
| 329 | - A mask can be applied to 2D calculation and fitting. |
|---|
| 330 | - Normalized residual plots are provided with every fit. |
|---|
| 331 | - Model function help available through detail button or from the fitting panel. |
|---|
| 332 | - Simultaneous/(advanced)constrained fitting allows for fitting a single |
|---|
| 333 | data set or several different sets simultaneously with the application |
|---|
| 334 | of advanced constraints relating fit parameters to functions of other |
|---|
| 335 | parameters (including from a different set). For example thickness of |
|---|
| 336 | shell = sin(30) times the length. |
|---|
| 337 | - Models that are the sum of two other models can be easily generated through the |
|---|
| 338 | SUM Model menubar item. |
|---|
| 339 | - New Python models can be added on the fly by creating an appropriate Python |
|---|
| 340 | file in the model plugin directory. Two tools are provided to help: |
|---|
| 341 | An easy to use custom model editor allows the quick generation of new Python |
|---|
| 342 | models by supplying only the parameters and their default value (box 1) |
|---|
| 343 | and the mathematical function of the model (box 2) and generating the |
|---|
| 344 | necessary *.py file. A separate advanced model editor provides a full Python |
|---|
| 345 | file editor. Either way once saved the model becomes immediately available |
|---|
| 346 | to the application. |
|---|
| 347 | - A batch fitting capability allows for the analysis of a series of data sets to |
|---|
| 348 | a single model and provides the results in a tabular form suitable for saving |
|---|
| 349 | or plotting the evolution of the fit parameters with error bars (from within |
|---|
| 350 | the application). |
|---|
| 351 | |
|---|
| 352 | - Tools |
|---|
| 353 | - A scattering length density calculator,including some X-ray information |
|---|
| 354 | is provided. |
|---|
| 355 | - A density to vol. fraction converter is provided |
|---|
| 356 | - In application access to a Python shell/editor (PyCrust) is provided |
|---|
| 357 | - An instrument resolution calculator, including possible gravitational and |
|---|
| 358 | TOF effects is provided |
|---|
| 359 | - A slit size calculator optimized for Anton Paar Saxess is provided. |
|---|
| 360 | - A kiessig fringe thickness calculator is provided |
|---|
| 361 | |
|---|
| 362 | - Plots and plot management |
|---|
| 363 | - A 3D graphing option (for 2d data/results) is provided with the view |
|---|
| 364 | controlled by the mouse |
|---|
| 365 | - 2D plots are shown with an intensity color bar. 2D Color map can be user |
|---|
| 366 | adjusted. |
|---|
| 367 | - Supports output of plot to a variety of graphic formats. Supported formats |
|---|
| 368 | include: png, eps, emf, jpg/jpeg, pdf, ps, tif/tiff, rawRGBbitmap(raw, rgba), |
|---|
| 369 | and scalable vector graphic (svg/svgz) |
|---|
| 370 | - Supports ouput of data in plot (1 or 2D) to limited data formats |
|---|
| 371 | - Multiple data sets can be loaded into a single graph for viewing (but a fit |
|---|
| 372 | plot can currently only have a single plot). |
|---|
| 373 | - Extensive context sensitive plot/fitting/manipulation options are available |
|---|
| 374 | through a right mouse click pop-up menu on plots. |
|---|
| 375 | |
|---|
| 376 | - Data management |
|---|
| 377 | - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data |
|---|
| 378 | via plug-in mechanism which can easily allow other readers as appropriate. |
|---|
| 379 | - 2D data is expected in Q space but for historical reasons accepts the |
|---|
| 380 | NIST 2D raw pixel format and will do conversion internally. |
|---|
| 381 | - The full data and metadata available to SasView is viewable in ASCII via |
|---|
| 382 | right clicking on a data set and choosing Data Info in the DataExplorer |
|---|
| 383 | or on the plots |
|---|
| 384 | - Supports loading a single file, multiple files, or a whole folder |
|---|
| 385 | - An optional Data Explorer is provided (default) which simplifies managing, |
|---|
| 386 | plotting, deleting, or setup for computation. Most functions however do |
|---|
| 387 | not require access to the explorer/manager and can be accessed through |
|---|
| 388 | right click menus and the toolbar. The data explorer can be re-started |
|---|
| 389 | from the menu bar. |
|---|
| 390 | |
|---|
| 391 | - Data manipulation |
|---|
| 392 | - Support various 2D averaging methods : Circular, sectors, annular, |
|---|
| 393 | boxsum, boxQx and boxQy. |
|---|
| 394 | - A 2D data maks editor is provided |
|---|
| 395 | - 2D mask can be applied to the circular averaging. |
|---|
| 396 | |
|---|
| 397 | - Miscellaneous features |
|---|
| 398 | - limited reports can be generated in pdf format |
|---|
| 399 | - Provides multiprocessor support(Windows only) |
|---|
| 400 | - Limited startup customization currently includes default startup |
|---|
| 401 | data folder and choice of default starting with data manager |
|---|
| 402 | - Limited support for saving(opening) a SasView project or a SasView analysis |
|---|
| 403 | (subproject) is provided. |
|---|
| 404 | - SasView can be launched and loaded with a file of interesty by double-clicking |
|---|
| 405 | on that file (recognized extension) |
|---|
| 406 | - A data file or data folder can be passed to SasView when launched from |
|---|
| 407 | the command line. |
|---|
| 408 | - Limited bookmarking capability to later recall the results of a fit calculation |
|---|
| 409 | is provided. |
|---|
| 410 | - Extensive help is provided through context sensitive mouse roll-over, |
|---|
| 411 | information bar (at the bottom of the panel), the console menu, and |
|---|
| 412 | access to the help files in several different ways. |
|---|
| 413 | |
|---|
| 414 | |
|---|
| 415 | 2- Downloading and Installing |
|---|
| 416 | ============================= |
|---|
| 417 | |
|---|
| 418 | *** Note 1: Much more information is available at www.sasview.org under links. |
|---|
| 419 | Look in the 'For Developers' section and particularly the wiki at |
|---|
| 420 | www.sasview.org/trac/wiki. |
|---|
| 421 | *** Note 2: If you have EXE or ZIP SasView installer, you won't need any of |
|---|
| 422 | the following. However it is highly recommended that any |
|---|
| 423 | previous versions be un-installed prior to installing the |
|---|
| 424 | new version. |
|---|
| 425 | |
|---|
| 426 | 2.1- System Requirements |
|---|
| 427 | - Python version >= 2.5 and < 3.0 should be running on the system |
|---|
| 428 | - We currently use Python 2.7 |
|---|
| 429 | |
|---|
| 430 | 2.2- Installing from source |
|---|
| 431 | - Get the source code |
|---|
| 432 | - to follow the current development version from source control use |
|---|
| 433 | git clone https://github.com/SasView/sasview.git |
|---|
| 434 | git clone https://github.com/bumps/bumps.git |
|---|
| 435 | - to install a specific version |
|---|
| 436 | |
|---|
| 437 | - Build, install and run a specific release |
|---|
| 438 | - make sure the requirements below are already installed |
|---|
| 439 | - retrieve the source from https://github.com/SasView/sasview/releases |
|---|
| 440 | - open a command line window in the 'sasview-x.x.x' directory |
|---|
| 441 | - run 'python setup.py install' |
|---|
| 442 | - run 'python sasview.py' under the 'sasview' folder. |
|---|
| 443 | |
|---|
| 444 | - Build, install and run the current development version |
|---|
| 445 | - clone the source from git; also clone bumps, which is developed in parallel |
|---|
| 446 | git clone https://github.com/SasView/sasview.git |
|---|
| 447 | git clone https://github.com/bumps/bumps.git |
|---|
| 448 | - open a command line window in the 'sasview' directory |
|---|
| 449 | - run 'python setup.py build' |
|---|
| 450 | - run 'python run.py'; this runs from the source directories, so you |
|---|
| 451 | don't have to rebuild every time you make a change, unless you are |
|---|
| 452 | changing the C++ model files |
|---|
| 453 | |
|---|
| 454 | - The following modules are required (version numbers are what are used |
|---|
| 455 | in the windows release build): |
|---|
| 456 | |
|---|
| 457 | - Common Packages |
|---|
| 458 | - reportlab 3.1.44 |
|---|
| 459 | - lxml 3.4.4.0 (MAC 3.4.2.0) |
|---|
| 460 | - PIL 1.1.7 |
|---|
| 461 | - xhtml2pdf 3.0.33 (MAC = not installed on build server) |
|---|
| 462 | - unittest-xml-reporting 1.12.0 (MAC 1.10.0) |
|---|
| 463 | - matplotlib Version Installed: 1.4.3 (MAC 1.1.1) |
|---|
| 464 | - bumps Version Installed: 0.7.5.9 |
|---|
| 465 | - scipy Version Installed: 0.16.0b2 (MAC 0.11.0) |
|---|
| 466 | - periodictable Version Installed: 1.4.1 |
|---|
| 467 | - setuptools Version Installed: 7.0 (MAC 12.0.5) |
|---|
| 468 | - sphinx Version Installed: 1.3.1 (MAC 1.3b2) |
|---|
| 469 | - pyparsing Version Installed: 2.0.3 |
|---|
| 470 | - numpy Version Installed: 1.9.2 (MAC 1.6.2) |
|---|
| 471 | - html5lib Version Installed: 0.99999 |
|---|
| 472 | - wx Version Installed: 3.0.2.0 |
|---|
| 473 | |
|---|
| 474 | - Windows Specific Packages |
|---|
| 475 | - pywin 219 |
|---|
| 476 | - py2exe 0.6.9 |
|---|
| 477 | - comtypes 1.1.1 |
|---|
| 478 | - MinGW w/ gcc version 4.6.1 (WIN) |
|---|
| 479 | - vcredist_x86.exe (version 9.0.21022.8 -microsoft visual C 2008 |
|---|
| 480 | re-distributable) |
|---|
| 481 | - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable |
|---|
| 482 | |
|---|
| 483 | *** Note: Windows build dependencies can be set up using anaconda. Instructions |
|---|
| 484 | can be found at http://trac.sasview.org/wiki/AnacondaSetup |
|---|
| 485 | |
|---|
| 486 | - MAC Specifc Packages |
|---|
| 487 | - py2app 0.7.1 |
|---|
| 488 | |
|---|
| 489 | |
|---|
| 490 | 3- Known Issues |
|---|
| 491 | =============== |
|---|
| 492 | |
|---|
| 493 | |
|---|
| 494 | 4.1- All systems: |
|---|
| 495 | The conversion to sasmodels infrastructure is ongoing and should be |
|---|
| 496 | completed in the next release. In the meantime this leads to a few known |
|---|
| 497 | issues: |
|---|
| 498 | - The way that orientation is defined is being refactored to address |
|---|
| 499 | long standing issues and comments. In release 4.1 however only models |
|---|
| 500 | with symmetry (e.g. a=b) have been converted to the new definitions. |
|---|
| 501 | The rest (a <> b <> c - e.g. parellelepiped) maintain the same |
|---|
| 502 | definition as before and will be converted in 4.2. Note that |
|---|
| 503 | orientational distribution also makes much more sense in the new |
|---|
| 504 | framework. The documentation should indicate which definition is being |
|---|
| 505 | used for a given model. |
|---|
| 506 | - The infrastructure currently handles internal conversion of old style |
|---|
| 507 | models so that user created models in previous versions should continue |
|---|
| 508 | to work for now. At some point in the future such support will go away. |
|---|
| 509 | Everyone is encouraged to convert to the new structure which should be |
|---|
| 510 | relatively straight forward and provides a number of benefits. |
|---|
| 511 | - In that vein, the distributed models and those generated by the new |
|---|
| 512 | plugin model editor are in the new format, however those generated by |
|---|
| 513 | sum|multiply models are the old style sum|multiply models. This should |
|---|
| 514 | also disappear in the near future |
|---|
| 515 | - The on the fly discovery of plugin models and changes thereto behave |
|---|
| 516 | inconsistently. If a change to a plugin model does not seem to |
|---|
| 517 | register, the Load Plugin Models (under fitting -> Plugin Model |
|---|
| 518 | Operations) can be used. However, after calling Load Plugin Models, the |
|---|
| 519 | active plugin will no longer be loaded (even though the GUI looks like |
|---|
| 520 | it is) unless it is a sum|multiply model which works properly. All |
|---|
| 521 | others will need to be recalled from the model dropdown menu to reload |
|---|
| 522 | the model into the calculation engine. While it might be annoying it |
|---|
| 523 | does not appear to prevent SasView from working.. |
|---|
| 524 | - The model code and documentation review is ongoing. At this time the |
|---|
| 525 | core shell parellelepiped is known to have the C shell effectively fixed |
|---|
| 526 | at 0 (noted in documentation) while the triaxial ellipsoid does not seem |
|---|
| 527 | to reproduce the limit of the oblate or prolate ellipsoid. If errors are |
|---|
| 528 | found and corrected, corrected versions will be uploaded to the |
|---|
| 529 | marketplace. |
|---|
| 530 | |
|---|
| 531 | 3.1- All systems: |
|---|
| 532 | - The documentation window may take a few seconds to load the first time |
|---|
| 533 | it is called. Also, an internet connection is required before |
|---|
| 534 | equations will render properly. Until then they will show in their |
|---|
| 535 | original TeX format. |
|---|
| 536 | - If the documentation window remains stubbornly blank, try installing a |
|---|
| 537 | different browser and set that as your default browser. Issues have |
|---|
| 538 | been noted with Internet Explorer 11. |
|---|
| 539 | - Check for Updates may fail (with the status bar message ' Cannot |
|---|
| 540 | connect to the application server') if your internet connection uses |
|---|
| 541 | a proxy server. Tested resolutions for this are described on the |
|---|
| 542 | website FAQ. |
|---|
| 543 | - The copy and paste functions (^C, ^V) in the batch mode results grid |
|---|
| 544 | require two clicks: one to select the cell and a second to select the |
|---|
| 545 | contents of the cell. |
|---|
| 546 | - The tutorial has not yet been updated and is somewhat out of date |
|---|
| 547 | - Very old computers may struggle to run the 3.x and later releases |
|---|
| 548 | - Polydispersity on multiple parameters included in a simultaneous/ |
|---|
| 549 | constrained fit will likely not be correct |
|---|
| 550 | - Constrained/simultaneous fit page does not have a stop button |
|---|
| 551 | - Constrained/simultaneous fit do not accept min/max limits |
|---|
| 552 | - Save project does not store the state of all the windows |
|---|
| 553 | - Loading projects can be very slow |
|---|
| 554 | - Save Project only works once a data set has been associated with |
|---|
| 555 | a model. Error is reported on status bar. |
|---|
| 556 | - There is a numerical precision problem with the multishell model when |
|---|
| 557 | the iner radius gets large enough (ticket #288) |
|---|
| 558 | - The angular distribution angles are not clearly defined and may in |
|---|
| 559 | some cases lead to incorrect calculations(ticket #332) |
|---|
| 560 | |
|---|
| 561 | 3.2- Windows: |
|---|
| 562 | - If installed to same directory as old version without first removing |
|---|
| 563 | the old version, the old desktop icon will remain but point to the |
|---|
| 564 | new exe version. Likewise all the start menu folders and items will |
|---|
| 565 | have the old name even though pointing to the new version. Usually |
|---|
| 566 | safest to uninstall old version prior to installing new version anyway. |
|---|
| 567 | |
|---|
| 568 | 3.3- MAC: |
|---|
| 569 | - Application normally starts up hidden. Click icon in Dock to view/use |
|---|
| 570 | application. |
|---|
| 571 | - Multiprocessing does not currently work on MAC OS |
|---|
| 572 | |
|---|
| 573 | 3.4- Linux: |
|---|
| 574 | - Not well tested |
|---|
| 575 | |
|---|
| 576 | |
|---|
| 577 | 4- SasView website |
|---|
| 578 | ================== |
|---|
| 579 | |
|---|
| 580 | - www.sasview.org. This main project site is the gateway to all |
|---|
| 581 | information about the sasview project. It includes information |
|---|
| 582 | about the project, a FAQ page and links to all developer and user |
|---|
| 583 | information, tools and resources. |
|---|
| 584 | |
|---|
| 585 | |
|---|
| 586 | 5- Frequently Asked Questions |
|---|
| 587 | ============================= |
|---|
| 588 | |
|---|
| 589 | - www.sasview.org/faq.html |
|---|
| 590 | |
|---|
| 591 | |
|---|
| 592 | 6- Installer download website |
|---|
| 593 | ============================= |
|---|
| 594 | |
|---|
| 595 | - Latest release Version |
|---|
| 596 | - https://github.com/SasView/sasview/releases |
|---|
| 597 | - Latest developer builds |
|---|
| 598 | - https://jenkins.esss.dk/sasview/view/Master-Builds/ |
|---|
