Changeset 9687d58 in sasview for sasview/README.txt
- Timestamp:
- Apr 10, 2017 4:01:46 AM (7 years ago)
- Branches:
- 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
- Children:
- 6c8fb2c
- Parents:
- 9208346 (diff), c6f3aec (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent. - File:
-
- 1 edited
-
sasview/README.txt (modified) (26 diffs)
Legend:
- Unmodified
- Added
- Removed
-
sasview/README.txt
r153ee77 r9687d58 4 4 1- Features 5 5 =========== 6 - New in Version 4.0.1 7 ------------------ 8 This release fixes the critical bug #750 in P(Q)*S(Q). Most damaging 9 it appears that the background term was being added to S(Q) prior to 10 multiplication by P(Q). 11 12 13 - New in Version 4.0 14 ------------------ 15 This release fixes the various bugs found during the alpha and beta testing 16 - Improvements 17 - Support for reading data files from Anton Paar Saxess instruments 18 - Adds documentation on how to write custom models in the new framework 19 - Bug Fixes 20 - Fixes bug #604 Pringle model questions 21 - Fixes bug #472 Reparameterize Teubner-Strey 22 - Fixes bug #530 Numerical instabilities in Teubner Strey model 23 - Fixes bug #658 ASCII reader very broken 24 25 26 - New in Version 4.0 beta 1 27 -------------------- 28 This beta adds support for the magnetic and multilevel models of 3.1.2 29 and along with a host of bug fixes found in the alpha. 30 31 - Model package changes and improvements 32 - All 3.1.2 models now available in new interface 33 - Old custom models should now still work 34 - '''NOTE:''' These will be deprecated in a future version. Old 35 custom models should be converted to the new model format which 36 is now the same as the built in models and offers much better 37 support. 38 - Custom model editor now creates new style models 39 - Custom model editor supports better error checking 40 - Documentation improvements 41 - Continued general cleanup 42 - Other improvements/additions 43 - Support for new canSAS 2D data files added 44 - Plot axes range can now be set manually as well as by zooming 45 - Plot annotations can now be moved around after being placed on plot. 46 - The active optimizer is now listed on the top of the fit panel. 47 - Linear fits now update qmin and max when the x scale limits are 48 changed. Also the plot range no longer resets after a fit. 49 - Bug fixes 50 - Fixes bug #511 Errors in linearized fits and clean up of interface 51 including Kratky representation 52 - Fixes bug #186 Data operation Tool now executes when something is 53 entered in the text box and does not wait for the user to hit enter 54 - Fixes bug #459 plot context menu bug 55 - Fixes bug #559 copy to clipboard in graph menu broken 56 - Fixes bug #466 cannot remove a linear fit from graph 57 - Numerous bugs introduced in the alpha 58 59 6 60 7 61 - New in Version 4.0 beta 1 … … 79 133 - New in Version 3.1.2 80 134 -------------------- 81 This release is a major stability improvement, having fixed a serious bug 135 This release is a major stability improvement, having fixed a serious bug 82 136 that came to light since release 3.1.1. All users should upgrade. 83 137 84 - Fixes bug #468 broken remove constraint buttons in 138 - Fixes bug #468 broken remove constraint buttons in 85 139 simultaneous/constrained fitting panel 86 - Fixes bug #474 resulting from changes in 3.1.1 that had 140 - Fixes bug #474 resulting from changes in 3.1.1 that had 87 141 introduced an error in the high-Q of slit-smeared models. 88 - Fixes bug #478 which would cause wx to run out of IDs and result 142 - Fixes bug #478 which would cause wx to run out of IDs and result 89 143 in SasView crashing even if left alone. 90 144 - Fixes bug #479 missing help button on simultaneous/constrained fit page … … 110 164 documentation. 111 165 - The model help has been split so that the Details button now brings up 112 a very short pop-up giving the equation being used while HELP goes to 166 a very short pop-up giving the equation being used while HELP goes to 113 167 the section in the full documentation describing the model. 114 - Extensive help has also been added for the new optimizer engine (see 168 - Extensive help has also been added for the new optimizer engine (see 115 169 below) including rules of thumb on how and when to choose a given 116 170 optimizer and what the parameters do. … … 127 181 - A Nelder-Mead Simplex optimizer 128 182 - A Differential Evolution optimizer 129 - A Monte Carlo optimizer (DREAM) 183 - A Monte Carlo optimizer (DREAM) 130 184 - New models were added: 131 185 - MicelleSphCoreModel (currently residing in the Uncategorized category) … … 136 190 - RectangularHollowPrismInfThinWallsModel 137 191 - Infrastructure to allow SESANS data to be fit with models was added. This 138 will become available in a future release but can currently be used from 192 will become available in a future release but can currently be used from 139 193 the command line with some caveats. 140 194 - A number of bugs were fixed including a thread crashing issue and an … … 161 215 floating. 162 216 - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel, 163 RectangularPrismModel, RectangularHollowPrismModel and 217 RectangularPrismModel, RectangularHollowPrismModel and 164 218 RectangularHollowPrismInfThinWallsModel. 165 - The data loader now supports ILL DAT data files and reads the full meta 219 - The data loader now supports ILL DAT data files and reads the full meta 166 220 information from canSAS file formats. 167 221 - Redefined convention for specifying angular parameters for anisotropic 168 222 models. 169 - A number of minor features have been added such as permitting a log 170 distribution of points when using a model to simulate data, and the 223 - A number of minor features have been added such as permitting a log 224 distribution of points when using a model to simulate data, and the 171 225 addition of a Kratky plot option to the linear plots. 172 226 - A number of bugs have also been fixed. 173 227 - Save Project and Save Analysis now work more reliably. 174 - BETA: Magnetic contrast supporting full polarization analysis has been 228 - BETA: Magnetic contrast supporting full polarization analysis has been 175 229 implemented for some spherical and cylindrical models. 176 230 - BETA: Two new tools have been added: 177 - A generic scattering calculator which takes an atomic, magnetic or 178 SLD distribution in space and generates the appropriate 2D 179 scattering pattern. In some cases the orientationally averaged 180 (powder) 1D scattering can also be computed. Supported formats 181 include: SLD or text, PDB, and OMF magnetic moment distribution 231 - A generic scattering calculator which takes an atomic, magnetic or 232 SLD distribution in space and generates the appropriate 2D 233 scattering pattern. In some cases the orientationally averaged 234 (powder) 1D scattering can also be computed. Supported formats 235 include: SLD or text, PDB, and OMF magnetic moment distribution 182 236 file. 183 - An image viewer/converter for data in image format; this reads in 184 an image file and will attempt to convert the image pixels to 237 - An image viewer/converter for data in image format; this reads in 238 an image file and will attempt to convert the image pixels to 185 239 data. Supported formats include: TIFF, TIF, PNG, BMP, JPG. 186 240 … … 210 264 - Added more plot symbols options for 1d plots 211 265 - Added improved trapping of compiling errors to the 'New model editor' 212 - Added some intelligent outputs (e.g., Rg, background, or rod diameter 266 - Added some intelligent outputs (e.g., Rg, background, or rod diameter 213 267 depending on the choice of axis scale of the plot) to the linear fits 214 268 - Added more models 215 216 - Feature set from previous versions 269 270 - Feature set from previous versions 217 271 ----------------------------------- 218 272 - Perspectives Available … … 220 274 specific surface area. 221 275 - P(r) inversion calculator: Indirect Fourier transformation method. 222 - Fitting: the tool used for modeling and fitting 1D and 2D data to 276 - Fitting: the tool used for modeling and fitting 1D and 2D data to 223 277 analytical model functions 224 278 - Tools: provides a number of useful supplementary tools such as SLD 225 calculation 226 227 - Fitting 279 calculation 280 281 - Fitting 228 282 - Includes a large number of model functions, both form factors and structure factors. 229 283 - Support P(Q)*S(Q) for form factors that flag they can be so multiplied. … … 233 287 - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform 234 288 distribution of orientations of a given axis leading to modeling and fitting 235 capabilities of non azimuthaly symmetric data. 289 capabilities of non azimuthaly symmetric data. 236 290 - User can choose to weight fits or not. If using weights, the user can choose 237 291 the error bar on each point if provided in the file, the square root 238 of the intensity or the intensity itself. 292 of the intensity or the intensity itself. 239 293 - Instrumental resolution smearing of model or fits is provided with several 240 294 options: read the resolution/point fromt he file. Input a pinhole resolution … … 249 303 data set or several different sets simultaneously with the application 250 304 of advanced constraints relating fit parameters to functions of other 251 parameters (including from a different set). For example thickness of 252 shell = sin(30) times the length. 305 parameters (including from a different set). For example thickness of 306 shell = sin(30) times the length. 253 307 - Models that are the sum of two other models can be easily generated through the 254 308 SUM Model menubar item. … … 259 313 and the mathematical function of the model (box 2) and generating the 260 314 necessary *.py file. A separate advanced model editor provides a full Python 261 file editor. Either way once saved the model becomes immediately available 262 to the application. 315 file editor. Either way once saved the model becomes immediately available 316 to the application. 263 317 - A batch fitting capability allows for the analysis of a series of data sets to 264 318 a single model and provides the results in a tabular form suitable for saving 265 319 or plotting the evolution of the fit parameters with error bars (from within 266 320 the application). 267 321 268 322 - Tools 269 323 - A scattering length density calculator,including some X-ray information … … 275 329 - A slit size calculator optimized for Anton Paar Saxess is provided. 276 330 - A kiessig fringe thickness calculator is provided 277 331 278 332 - Plots and plot management 279 333 - A 3D graphing option (for 2d data/results) is provided with the view … … 289 343 - Extensive context sensitive plot/fitting/manipulation options are available 290 344 through a right mouse click pop-up menu on plots. 291 345 292 346 - Data management 293 347 - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data 294 via plug-in mechanism which can easily allow other readers as appropriate. 348 via plug-in mechanism which can easily allow other readers as appropriate. 295 349 - 2D data is expected in Q space but for historical reasons accepts the 296 350 NIST 2D raw pixel format and will do conversion internally. … … 298 352 right clicking on a data set and choosing Data Info in the DataExplorer 299 353 or on the plots 300 - Supports loading a single file, multiple files, or a whole folder 354 - Supports loading a single file, multiple files, or a whole folder 301 355 - An optional Data Explorer is provided (default) which simplifies managing, 302 356 plotting, deleting, or setup for computation. Most functions however do … … 304 358 right click menus and the toolbar. The data explorer can be re-started 305 359 from the menu bar. 306 360 307 361 - Data manipulation 308 362 - Support various 2D averaging methods : Circular, sectors, annular, … … 310 364 - A 2D data maks editor is provided 311 365 - 2D mask can be applied to the circular averaging. 312 366 313 367 - Miscellaneous features 314 368 - limited reports can be generated in pdf format … … 331 385 2- Downloading and Installing 332 386 ============================= 333 387 334 388 *** Note 1: Much more information is available at www.sasview.org under links. 335 389 Look in the 'For Developers' section and particularly the wiki at … … 370 424 - The following modules are required (version numbers are what are used 371 425 in the windows release build): 372 426 373 427 - Common Packages 374 428 - reportlab 3.1.44 … … 387 441 - html5lib Version Installed: 0.99999 388 442 - wx Version Installed: 3.0.2.0 389 443 390 444 - Windows Specific Packages 391 445 - pywin 219 … … 393 447 - comtypes 1.1.1 394 448 - MinGW w/ gcc version 4.6.1 (WIN) 395 - vcredist_x86.exe (version 9.0.21022.8 -microsoft visual C 2008 449 - vcredist_x86.exe (version 9.0.21022.8 -microsoft visual C 2008 396 450 re-distributable) 397 451 - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable … … 399 453 *** Note: Windows build dependencies can be set up using anaconda. Instructions 400 454 can be found at http://trac.sasview.org/wiki/AnacondaSetup 401 455 402 456 - MAC Specifc Packages 403 457 - py2app 0.7.1 404 458 405 459 406 460 3- Known Issues … … 412 466 equations will render properly. Until then they will show in their 413 467 original TeX format. 414 - If the documentation window remains stubbornly blank, try installing a 468 - If the documentation window remains stubbornly blank, try installing a 415 469 different browser and set that as your default browser. Issues have 416 470 been noted with Internet Explorer 11. 417 - Check for Updates may fail (with the status bar message ' Cannot 418 connect to the application server') if your internet connection uses 419 a proxy server. Tested resolutions for this are described on the 471 - Check for Updates may fail (with the status bar message ' Cannot 472 connect to the application server') if your internet connection uses 473 a proxy server. Tested resolutions for this are described on the 420 474 website FAQ. 421 475 - The copy and paste functions (^C, ^V) in the batch mode results grid 422 476 require two clicks: one to select the cell and a second to select the 423 contents of the cell. 477 contents of the cell. 424 478 - The tutorial has not yet been updated and is somewhat out of date 425 479 - Very old computers may struggle to run the 3.x and later releases … … 436 490 - The angular distribution angles are not clearly defined and may in 437 491 some cases lead to incorrect calculations(ticket #332) 438 492 439 493 3.2- Windows: 440 494 - If installed to same directory as old version without first removing … … 443 497 have the old name even though pointing to the new version. Usually 444 498 safest to uninstall old version prior to installing new version anyway. 445 499 446 500 3.3- MAC: 447 501 - Application normally starts up hidden. Click icon in Dock to view/use 448 application. 502 application. 449 503 - Multiprocessing does not currently work on MAC OS 450 504 451 505 3.4- Linux: 452 506 - Not well tested … … 456 510 ================== 457 511 458 - www.sasview.org. This main project site is the gateway to all 512 - www.sasview.org. This main project site is the gateway to all 459 513 information about the sasview project. It includes information 460 514 about the project, a FAQ page and links to all developer and user … … 475 529 - Latest developer builds 476 530 - https://jenkins.esss.dk/sasview/view/Master-Builds/ 477 478
Note: See TracChangeset
for help on using the changeset viewer.
