Skip to content

Releases: SasView/sasview

SasView 5.0 beta 2

08 Feb 13:44
Compare
Choose a tag to compare
SasView 5.0 beta 2 Pre-release
Pre-release

New in Version 5.0 Beta 2

This pre-release contains improvements and a number of bug fixes. This pre-release is based on Python 3 and Qt5/PyQt5.

Changes

  • Look and behaviour of the Constrained and Simultaneous Fitting panel has been reworked and improved significantly.
  • Project Load and Save have been re-implemented and improved.
  • Analysis Load and Save have been re-implemented and improved.
  • Project and Analysis Load is now backward compatible with version 4.
  • Image Viewer has been converted and redesigned.
  • The NeXus loader has been removed as it is superseded by the NXcanSAS standard loader and SasView does not support the treatment of raw data.
  • Fit results charts are now visible during the fitting process for more advanced optimizers.
  • Model Editor now allows for editing C++ files, if they are a part of the plugin model definition.
  • Binary signature of the Windows installer by European Spallation Source. This allows for authentication of the author and assurance of the installer's integrity.

Improvements

  • Updated to the most recent versions of Qt.
  • Improved Model Category Manager.
  • Added Close All Plots and Minimize All Plots functionality.
  • Drag and Drop file load now accepts also directories.
  • Multiple data loading improvements.
  • There have been numerous other bug fixes.

SasView 4.2.0

07 Oct 01:24
Compare
Choose a tag to compare

(Mac Users: please ensure you have the Xcode command line tools installed before installing SasView; get it from the App Store)

(Windows users: Windows installer is now signed so should not give warnings about installing from an unknown source)

New in Version 4.2.0

This release heralds many improvements and a host of bug fixes, along with some significant changes from previous versions. Further, as promised, it marks the end of support for 32 bit operating systems and is only available for 64 bit operating systems.

With this version the change to the new model API and plugins infrastructure begun with 4.0 is essentially complete (though extensions are in the works, and more are likely, they should remain backwardly compatible with previous versions of SasView).

Old-style plugin models, including old sum|multiply models, continue to be supported (i.e. SasView will run them) in 4.x, although our automatic on-the-fly translation may not cope in all use cases (see Known Issues below). However, this backward compatibility will be removed in 5.0 and users are therefore strongly encouraged to convert their custom models to the new API.

Finally, the changes to orientation angles and orientational distribution definitions are now also complete.

Changes

  • The infrastucture for calculating 2D patterns from 3D orientated objects has been totally re-factored. It is now more accurate and consistent across models.
  • The way that SasView defines the orientation of anisometric and aligned objects has been completely overhauled. It now differs from previous versions.
  • Plugin models, including sum|multiply models, have completely migrated to the new infrastructure. NOTE that 3.x type models as well as early, intermediate 4.x type models, including those generated by sum|multiply will continue to be supported in 4.x but will likely no longer be supported after the move to 5.0. Users are strongly encouraged to migrate any custom models.
  • The NeXus loader has been removed as it is superseded by the NXcanSAS standard loader and SasView does not support the treatment of raw data.

Improvements

  • The accuracy/speed of some numerical integrations have been improved.
  • An orientation viewer tool has been introduced to assist in understanding the new orientation framework.
  • Problems with the computation of magnetic scattering from some objects have been rectified. Some questions remain however.
  • The known issue with the core_shell_parallelepiped model is now fixed.
  • An error in the be_polyelectrolyte model was identified and rectified, but the fix is yet to be validated.
  • A number of issues and inconsistencies with the creation of sum|multiply models have been rectified.
  • A Boltzmann distribution has been added for polydispersity/orientational distributions.
  • Some batch slicing options have been introduced.
  • Correlation function analysis now computes both the 1D and 3D functions.
  • There are several data loading improvements.
  • There are several improvements to Save/Load Project.
  • The SasView version number now appears in Reports.
  • The Release Notes are now available from the program Help menu.
  • There have been numerous other bug fixes.

Documentation

Several sections of the help documentation have undergone significant checking and updating, particularly those relating to orientation, magnetic scattering, and polydispersity distributions.

Detailed advanced instructions for plugin writing and some scripting instructions have also been added.

Concerns about the intended versus implemented meaning of some parameters in the bcc_paracrystal, fcc_paracrystal, and sc_paracrystal models have been brought to our attention. These have yet to be resolved and so a Warning has been placed on each of these models. Anyone who feels they may have the requisite expertise to investigate these concerns is strongly encouraged to contact the Developers!

Other Work

  • A Third-Party initiative has recently succeeded in getting SasView to run on Debian. More details at http://trac.sasview.org/wiki/DevNotes/Projects/Debian
  • With this release we have started to prepare for the inevitable move to Python 3, which will occur with the release of 5.0
  • SasView 5.0 is currently in development. The two most significant features of this version will be (i) a move away from the present WxPython GUIs to new, completely rewritten, Qt5 GUIs, and (ii)implementation of the Beta-approximation for S(Q). Subject to resources, some limited access to the latter functionality may be available in a future SasView 4.x release.

Bug Fixes

  • Fixes # 14: Loading a saved project is really really slow
  • Fixes # 260: Box integration does not update when entering values in dialog
  • Fixes # 446: Saving plot as PGF (not PDF!) format throws error
  • Fixes # 467: Extend batch functionality to slicer
  • Fixes # 489: ABS reader (NIST 1D) does not handle negative dx properly (USANS slit smearing)
  • Fixes # 499: create sin(x)/x, 2J1(x)/x and 3j1(x)/x functions
  • Fixes # 510: Build PDF documentation along with HTML
  • Fixes # 525: Add GUI category defaults to models in sasmodels
  • Fixes # 579: clean up sasview directory
  • Fixes # 597: Need to document Combine Batch Fit
  • Fixes # 645: GUI logic problem in Batch vs single fit mode
  • Fixes # 648: Need to allow user input background value in Pr perspective
  • Fixes # 685: Fix data upload to marketplace
  • Fixes # 695: linear slope in onion model
  • Fixes # 735: Review new Corfunc documentation
  • Fixes # 741: Recalculate P(Q) and S(Q) components on model update.
  • Fixes # 767: Sum/Product Models don't do what they should
  • Fixes # 776: angular dispersity
  • Fixes # 784: Add 3D integral to Correlation Function analysis
  • Fixes # 786: core_shell_parallelepiped 1-D model is incorrect
  • Fixes # 818: report button followed by save makes an empty pdf file???
  • Fixes # 830: Check compliance of loader against NXcanSAS-1.0 release
  • Fixes # 838: Fix model download from marketplace
  • Fixes # 848: can't save analysis when only one fit page
  • Fixes # 849: Load Folder should ignore files starting with .
  • Fixes # 852: More unit tests, especially for oriented or 2d models
  • Fixes # 854: remove unnecessary sleep() in fitting perspective
  • Fixes # 856: Reading SAS_OPENCL from custom_config sometimes raises an ERROR
  • Fixes # 861: cannot defined a structure factor plugin
  • Fixes # 864: New Model Editor (simple plugin editor) error parsing parameter line
  • Fixes # 865: Plugin live discovery issues
  • Fixes # 866: inform user when NaN is returned from compute
  • Fixes # 869: fit page computation thread cleanup
  • Fixes # 875: Possible weirdness with 1D NXcanSAS data
  • Fixes # 876: Add check for HDF5 format in dataloader
  • Fixes # 887: reorganize tree, separating the installed source from the build source
  • Fixes # 889: Refactor dataloader error handling infrastructure
  • Fixes # 890: use new orientation definition for asymmetric shapes
  • Fixes # 891: update docs for oriented shapes with new orientation definition
  • Fixes # 896: equations in core shell parallelepiped docs do not match code
  • Fixes # 898: Image Viewer Tool file selector issue
  • Fixes # 899: Igor Reader q calculation
  • Fixes # 902: IgorReader Q calculation needs fixing/improving
  • Fixes # 903: sasview - all non-gui tests should be converted to run in Python 3
  • Fixes # 906: polydispersity not showing up in tabulated results
  • Fixes # 912: About box points to misleading contributors page on Github
  • Fixes # 913: Need to add Diamond developer and logo in relevant places
  • Fixes # 915: load project issues
  • Fixes # 916: Proper Logging
  • Fixes # 920: Logarithmic binning option in the slice viewer
  • Fixes # 921: Improve developer communication methods
  • Fixes # 922: Remove support for all data formats that are not in q space
  • Fixes # 923: Add CI and trac integrations to Slack
  • Fixes # 930: fitting help says chisq is normalized to number of points
  • Fixes # 931: Allow admins to edit all models and upload data etc on marketplace
  • Fixes # 932: Need to fix upload of data files to marketplace
  • Fixes # 934: Slurp tutorial repo for tutorials
  • Fixes # 935: Build new tutorials as PDF
  • Fixes # 943: Deep copy error on setting model after data is selected
  • Fixes # 950: Most of the readers don't close files properly.
  • Fixes # 954: cross check dll/opencl/python polydispersity and orientation results
  • Fixes # 956: Possible problem with new doc build process
  • Fixes # 961: sasmodels tests should fail if the parameter name does not exist
  • Fixes # 962: star polymer typo in docs
  • Fixes # 966: Inconsistent chi2 reporting
  • Fixes # 967: no uncertainties errors on fitting parameters
  • Fixes # 969: About Box not picking up dls_logo.png
  • Fixes # 970: ASCII loader doesn't handle ISIS 2D ASCII
  • Fixes # 974: blacklist Intel HD 620/630 for double precision
  • Fixes # 978: load project fails for pages which have not been defined
  • Fixes # 983: Remove Nexus Loader
  • Fixes # 984: PDF reports are not being properly generated on Windows
  • Fixes # 985: Saving Project Fails
  • Fixes # 986: Send to fitting overwrites theory page even if blank FitPage has focus
  • Fixes # 990: utest_sasview.py giving different results than run_one.py
  • Fixes # 993: Windows x64 versions not installing to correct folder
  • Fixes # 994: Error changing fit engine
  • Fixes # 995: OpenCL required on Linux even if turned off in GUI
  • Fixes #1006: multiplicity models don't work with SQ
  • Fixes #1007: spherical_sld model freezes SasView
  • Fixes #1008: plugin model scaling not working?
  • Fixes #1010: Win64 build script not creating working executable
  • Fixes #1011: sld_test failing on ubuntu
  • Fixes #1013: FileReaderBaseClass output[] not reset - same file loaded multiple times
  • Fixes #1018: add Boltzmann distribution
  • Fixes #...
Read more

This is a beta.1 pre-release version of 5.0.

05 Oct 09:08
Compare
Choose a tag to compare

Full release notes will be compiled prior to the full release 5.0.

SasView 5.0 highlights

  • New, completely refactored GUI
  • Fitting analysis interface simplified
  • Constraints definition logic simplified and functionality extended
  • Plugin model editor refactored and functionality extended
  • Polydispersity plots added
  • Improved stability and reliability
  • Better user experience
  • More logical workflows
  • PyQt 5 based GUI
  • Python3 compatibility

beta.1 is a stable version but may not be bug free. There are features like project loading and DREAM results panel that haven't been fully implemented yet.

This project receives funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 654000

SasView 4.2.0 Beta

09 Jul 22:12
9b2b657
Compare
Choose a tag to compare
SasView 4.2.0 Beta Pre-release
Pre-release

This is a beta pre-release version of 4.2.0. A number of fixes and changes
have been made in the year since the previous release.
Full release notes will be compiled prior to the full release 4.2.0.

Highlights are:

  • Infrastucture for calculating 2D patterns from 3D orientated objects has now been totally refactored

  • Plugins have completely migrated to the new infrastructure now, including sum/multiply models

  • Some batch slicing options have been introduced

  • The known issue with the core_shell_parallelepiped is now fixed

  • Several data loading improvements

  • Several save Project improvements (though there are more to come)

  • Numerous bug fixes

  • Lots of documentation enhancement

    In the meantime please report any bugs or issues found while using this beta

SasView 4.1.2

14 Aug 20:15
Compare
Choose a tag to compare

This is a bug-fix release.

Bug Fixes

  • Fixes #984: PDF Reports Generate Empty PDFs
  • Fixes a path typo in the 32 bit build script
  • 32 and 64 bit Windows executables are now available

Acknowledgement and citation

If you publish work making use of SasView 4.1.2, please include the following text:
This work benefited from the use of the SasView application, originally developed under NSF Award DMR-0520547. SasView also contains code developed with funding from the EU Horizon 2020 programme under the SINE2020 project Grant No 654000.

SasView 4.1.2 can be cited as :
M. Doucet, et al. SasView Version 4.1.2, http://doi.org/10.5281/zenodo.825675

Bug Reporting

Please support the project by reporting bugs that you find to [email protected]

All the known bugs/feature requests can be found at: http://trac.sasview.org/report/3

Regular developer builds are also available from https://jenkins.esss.dk/sasview/ if you wish to test the very latest (most likely unstable) versions of SasView.

[This release makes use of sasmodels v0.96]

SasView 4.1.1

14 Jul 19:36
Compare
Choose a tag to compare

This point release is a bug-fix release.

Bug Fixes

  • Fixes #948: Mathjax CDN is going away
  • Fixes #938: Cannot read canSAS1D file output by SasView
  • Fixes #960: Save project throws error if empty fit page
  • Fixes #929: Problem deleting data in first fit page
  • Fixes #918: Test folders not bundled with release
  • Fixes an issue with the live discovery of plugin models
  • Fixes an issue with the NXcanSAS data loader
  • Updates tutorials for SasView 4.x.y

Acknowledgement and citation

If you publish work making use of SasView 4.1.1, please include the following text:
This work benefited from the use of the SasView application, originally developed under NSF Award DMR-0520547. SasView also contains code developed with funding from the EU Horizon 2020 programme under the SINE2020 project Grant No 654000.

SasView 4.1.1 can be cited as :
M. Doucet, et al. SasView Version 4.1.1, Zenodo, http://doi.org/10.5281/zenodo.438138

Bug Reporting

Please support the project by reporting bugs that you find to [email protected]

All the known bugs/feature requests can be found at: http://trac.sasview.org/report/3

Regular developer builds are also available from https://jenkins.esss.dk/sasview/ if you wish to test the very latest (most likely unstable) versions of SasView.

[This release makes use of sasmodels v0.96]

SasView 4.1.0

30 Mar 16:28
@ajj ajj
Compare
Choose a tag to compare

This point release brings a series of new features and improvements, and a host of bug fixes. Of particular note are:

Correlation Function Analysis (Corfunc)

This performs a correlation function analysis of one-dimensional SAXS/SANS data using Adam Washington`s CorfuncPy package. This essentially provides the capability of the old CCP13 CORFUNC package to the current generation of small-angle scatterers.

A correlation function may be interpreted in terms of an imaginary rod of a given length moving through the structure of the material under study. It is the probability that the rod will have equal electron/neutron scattering length density at either end. Hence, repeatedly occurring regions of similar density within the material will be manifested as a peak in the correlation function.

Fitting of SESANS Data

Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will be plotted against the correct axes and models will automatically perform a Hankel transform in order to calculate SESANS from a SANS model.

Documentation

The documentation has undergone significant checking and updating.

Acknowledgement and citation

If you publish work making use of SasView 4.0, please include the following text:

This work benefited from the use of the SasView application, originally developed under NSF Award DMR-0520547. SasView also contains code developed with funding from the EU Horizon 2020 programme under the SINE2020 project Grant No 654000.

SasView can be cited as :

M. Doucet, et al. SasView Version 4.1, Zenodo, http://doi.org/10.5281/zenodo.438138

New Features

  • Correlation function (corfunc) analysis of 1D SAS data added from CCP13
  • File converter tool for multi-file single column data sets
  • SESANS data loading and direct fitting using the Hankel transformation
  • Saving and loading of simultaneous and constrained fits now supported
  • Save states from SasView v3.x.y now loaded using sasmodel model names
  • Saving and loading of projects with 2D fits now supported
  • Loading a project removes all existing data, fits, and plots
  • OpenCL is disabled by default and can be enabled through a fit menu
  • Data and theory fields are now independently expandable

Bug Fixes

  • Fixes #667: Models computed multiple times on parameters changes
  • Fixes #673: Custom models override built in models of same name
  • Fixes #678: Hard crash when running complex models on GPU
  • Fixes $774: Old style plugin models unloadable
  • Fixes #789: stacked disk scale doesn't match cylinder model
  • Fixes #792: core_shell_fractal uses wrong effective radius
  • Fixes #800: Plot range reset on plot redraws
  • Fixes #811 and #825: 2D smearing broken
  • Fixes #815: Integer model parameter handling
  • Fixes #824: Cannot apply sector averaging when no detector data present
  • Fixes #830: Cansas HDF5 reader fully compliant with NXCanSAS v1.0 format
  • Fixes #835: Fractal model breaks with negative Q values
  • Fixes #843: Multilayer vesicle does not define effective radius
  • Fixes #858: Hayter MSA S(Q) returns errors
  • Numerous grammatical and contexual errors in documention

Current Known Issues

Listed here are known issues that users should be aware of. A full list of known bugs and feature requests is available at http://trac.sasview.org/report/3

Critical

  • No currently known critical issues

Other Significant

  • The way that orientation is defined is being refactored to address long standing issues and comments. In release 4.1 however only models with symmetry (e.g. a=b) have been converted to the new definitions. The rest (a <> b <> c - e.g. parellelepiped) maintain the same definition as before and will be converted in 4.2. Note that orientational distribution also makes much more sense in the new framework. The documentation should indicate which definition is being used for a given model.
  • The infrastructure currently handles internal conversion of old style models so that user created models in previous versions should continue to work for now. At some point in the future such support will go away. Everyone is encouraged to convert to the new structure which should be relatively straight forward and provides a number of benefits.
  • In that vein, the distributed models and those generated by the new plugin model editor are in the new format, however those generated by sum|multiply models are the old style sum|multiply models. This should also disappear in the near future.
  • The on the fly discovery of plugin models and changes thereto behave inconsistently. If a change to a plugin model does not seem to register, the Load Plugin Models (under fitting -> Plugin Model Operations) can be used. However, after calling Load Plugin Models, the active plugin will no longer be loaded (even though the GUI looks like it is) unless it is a sum|multiply model which works properly. All others will need to be recalled from the model dropdown menu to reload the model into the calculation engine. While it might be annoying it does not appear to prevent SasView from working..

Model Issues

Corrections will be posted to Marketplace as available (and fixed in following release)

  • Core shell parrallelipiped fails to calculate the long (C side) shell. If set non-zero this leads to an incorrect volume normalization and thus to an incorrect absolute scaling. This has apparently always been true. If thick_C is set to zero the model behaves correctly.
  • Triaxial ellipsoid does not reproduce the limiting cases of oblate or prolate ellipsoid.

Bug Reporting

Please support the project by reporting bugs that you find to [email protected]

All the known bugs/feature requests can be found at: http://trac.sasview.org/report/3

Regular developer builds are also available from https://jenkins.esss.dk/sasview/ if you wish to test the very latest (most likely unstable) versions of SasView.

[This release makes use of sasmodels v0.96]

SasView 4.1 RC2

26 Mar 09:05
@ajj ajj
Compare
Choose a tag to compare
SasView 4.1 RC2 Pre-release
Pre-release

This point release brings a series of new features and improvements,
and a host of bug fixes. Of particular note are:

Correlation Function Analysis (Corfunc)

This performs a correlation function analysis of one-dimensional SAXS/SANS data,
or generates a model-independent volume fraction profile from the SANS from an
adsorbed polymer/surfactant layer.

A correlation function may be interpreted in terms of an imaginary rod moving
through the structure of the material. It is the probability that a rod of
length R moving through the material has equal electron/neutron scattering
length density at either end. Hence a frequently occurring spacing within a
structure manifests itself as a peak.

A volume fraction profile describes how the density of polymer
segments/surfactant molecules varies with distance from an (assumed locally flat)
interface.

Fitting of SESANS Data

Data from Spin-Echo SANS measurements can now be loaded and fitted. The data will
be plotted against the correct axes and models will automatically perform a Hankel
transform in order to calculate SESANS from a SANS model.

Documentation

The documentation has undergone significant checking and updating.

Acknowledgement and citation

If you publish work making use of SasView 4.0, please include the following text:

This work benefited from the use of the SasView application, originally developed under NSF Award DMR-0520547. SasView also contains code developed with funding from the EU Horizon 2020 programme under the SINE2020 project Grant No 654000.

SasView can be cited as :

M. Doucet, et al. SasView Version 4.1, Zenodo, http://doi.org/10.5281/zenodo.438138

New Features

  • Correlation function (corfunc) analysis of 1D SAS data added from CCP13
  • File converter tool for multi-file single column data sets
  • SESANS data loading and direct fitting using the Hankel transformation
  • Saving and loading of simultaneous and constrained fits now supported
  • Save states from SasView v3.x.y now loaded using sasmodel model names
  • Saving and loading of projects with 2D fits now supported
  • Loading a project removes all existing data, fits, and plots
  • Structure factor and form factor can be plotted independently
  • OpenCL is disabled by default and can be enabled through a fit menu
  • Data and theory fields are now independently expandable

Bug Fixes

  • Fixes #667: Models computed multiple times on parameters changes
  • Fixes #673: Custom models override built in models of same name
  • Fixes #678: Hard crash when running complex models on GPU
  • Fixes $774: Old style plugin models unloadable
  • Fixes #789: stacked disk scale doesn't match cylinder model
  • Fixes #792: core_shell_fractal uses wrong effective radius
  • Fixes #800: Plot range reset on plot redraws
  • Fixes #811 and #825: 2D smearing broken
  • Fixes #815: Integer model parameter handling
  • Fixes #824: Cannot apply sector averaging when no detector data present
  • Fixes #830: Cansas HDF5 reader fully compliant with NXCanSAS v1.0 format
  • Fixes #835: Fractal model breaks with negative Q values
  • Fixes #843: Multilayer vesicle does not define effective radius
  • Fixes #858: Hayter MSA S(Q) returns errors
  • Numerous grammatical and contexual errors in documention

Current Known Issues

Listed here are known issues that users should be aware of. A full list of known bugs and feature requests is available at http://trac.sasview.org/report/3

Critical

  • No currently known critical issues

Other Significant

  • The way that orientation is defined is being refactored to address long standing issues and comments. In release 4.1 however only models with symmetry (e.g. a=b) have been converted to the new definitions. The rest (a <> b <> c - e.g. parellelepiped) maintain the same definition as before and will be converted in 4.2. Note that orientational distribution also makes much more sense in the new framework. The documentation should indicate which definition is being used for a given model.
  • The infrastructure currently handles internal conversion of old style models so that user created models in previous versions should continue to work for now. At some point in the future such support will go away. Everyone is encouraged to convert to the new structure which should be relatively straight forward and provides a number of benefits.
  • In that vein, the distributed models and those generated by the new plugin model editor are in the new format, however those generated by sum|multiply models are the old style sum|multiply models. This should also disappear in the near future.
  • The on the fly discovery of plugin models and changes thereto behave inconsistently. If a change to a plugin model does not seem to register, the Load Plugin Models (under fitting -> Plugin Model Operations) can be used. However, after calling Load Plugin Models, the active plugin will no longer be loaded (even though the GUI looks like it is) unless it is a sum|multiply model which works properly. All others will need to be recalled from the model dropdown menu to reload the model into the calculation engine. While it might be annoying it does not appear to prevent SasView from working..

Model Issues

Corrections will be posted to Marketplace as available (and fixed in following release)

  • Core shell parrallelipiped fails to calculate the long (C side) shell. If set non-zero this leads to an incorrect volume normalization and thus to an incorrect absolute scaling. This has apparently always been true. If thick_C is set to zero the model behaves correctly.
  • Triaxial ellipsoid does not reproduce the limiting cases of oblate or prolate ellipsoid.

Bug Reporting

Please support the project by reporting bugs that you find to [email protected]

All the known bugs/feature requests can be found at: http://trac.sasview.org/report/3

Regular developer builds are also available from https://jenkins.esss.dk/sasview/ if you wish to test the very latest (most likely unstable) versions of SasView.

[This release makes use of sasmodels v0.96]

SasView 4.0.1

08 Nov 07:25
@ajj ajj
Compare
Choose a tag to compare

All users of 4.0 should upgrade to this version

This point release is specifically to address the problems with P(Q)*S(Q) in v4.0.0 that resulted as side-effects of the model infrastructure redesign.

From the Known Issues in v4.0 :

Critical - will be fixed in a bug release due imminently:

As part of the model structure refactoring a new bug was introduced that makes P * S unusable in this version unless the background is fixed to zero: The background is multiplied by P(q) including all the scaling factors. Release 4.0.1 should be available soon that fixes this.

This behaviour of P(Q)S(Q) is now corrected and non zero backgrounds are possible and the extraneous scaling factors have been removed. The effective radius used for the structure factor is *still calculated (as per the documentation) automatically from the form factor using the radius of a sphere that has the same second viral coefficient as the particle. This is only valid for particles with limited axial ratios.

[This release makes use of sasmodels v0.95]

SasView 4.0

02 Oct 09:26
@ajj ajj
Compare
Choose a tag to compare

The main purpose of this major version release is a significant restructuring of the way models work to address one of the biggest issues identified by the community: the difficulty of adding complex custom models. With this release all models are essentially treated the same within the computational framework. The "built-in" models have been separated out into an independent sasmodels package. Custom models continue to be discovered by placing them in the user plugin directory. All models consist of 1 or optionally 2 files: a model.py file containing much of the details (name, parameters, etc) and either the methods for computing intensity or links to an optional model.c which contains the computational code. All models, whether from sasmodels package or in the plugins directory are treated the same by the SasView application.

Other things of note in this release:

  • Support for openCL means that running on macs will automatically use GPUs or multiple CPU if they exist. This is true for most windows machines as well, but in some cases the user will need to download and install the openCL drivers for their computer.
  • All model documentation has been reviewed and updated
  • A number of other minor bugs and improvement

IMPORTANT NOTICE 1 We will attempt to keep a living list of significant reported/verified issues in the known issues section at the bottom of this page. There is currently 1 critical issue and a few others reported.
IMPORTANT NOTICE 2 Release 4.1 will probably be the last to support 32 bit operating systems. Older versions will always be available for 32 bit use if necessary.

Acknowledgement and citation

If you publish work making use of SasView 4.0, please include the following text:

"This work was originally developed as part of the DANSE project funded by the US NSF under Award DMR-0520547, but is currently maintained by a collaboration between UTK, UMD, NIST, ORNL, ISIS, ESS, ILL and ANSTO. SasView also contains code developed with funding from the EU Horizon 2020 research and innovation programme under the SINE2020 project (Grant No 654000)."

SasView can be cited as :

M. Doucet, et al. SasView Version 4.0, Zenodo, http://doi.org/10.5281/zenodo.159083

New Features

Model package changes and improvements

  • All 3.1.2 models now available in new interface
    • NB: RPA model is currently not available, but will be made available again later in the next point release.
  • Most old custom models should now still work
    • NOTE These will be deprecated in a future version. Old
      custom models should be converted to the new model format which
      is now the same as the built in models and offers much better
      support.
  • Custom model editor now creates new style models
  • Custom model editor supports better error checking

Documentation improvements

  • Continued general cleanup
  • Documentation of how to write new style models
  • All model docs checked for correctness and consistency with code

Other improvements/additions

  • Support for new canSAS 2D data files added
  • Plot axes range can now be set manually as well as by zooming
  • Plot annotations can now be moved around after being placed on plot.
  • The active optimizer is now listed on the top of the fit panel.
  • Linear fits now update qmin and max when the x scale limits are
    changed. Also the plot range no longer resets after a fit.
  • Magnetic models now supported in builtin models and custom models using C
  • Multilevel models (with the exception of RPA) now supported

Bug Fixes

  • Fixes bug #604 Pringle model questions
  • Fixes bug #472 Reparameterize Teubner-Strey
  • Fixes bug #530 Numerical instabilities in Teubner Strey model
  • Fixes bug #658 ASCII reader very broken
  • Fixes bug #511 Errors in linearized fits and clean up of interface
    including Kratky representation
  • Fixes bug #186 Data operation Tool now executes when something is
    entered in the text box and does not wait for the user to hit enter
  • Fixes bug #459 plot context menu bug
  • Fixes bug #559 copy to clipboard in graph menu broken
  • Fixes bug #466 cannot remove a linear fit from graph
  • Numerous bugs introduced in the alpha
  • Fixes bug #636 qmin error erroneuously thrown to console before successfully fitting for select models
  • Fixes #633 P(r) crashing on Sasview when entering 0.0 for Dmax
  • Fixes #642 canSAS 1D xml file take forever to load
  • Fixes #644 Loading saved fit or project opens multiple plot and fit windows and can throw error messages to the console
  • Fixes #635 n_layers = 0 causes errors to be thrown at least on windows
  • Fixes #658 Generic ASCII reader broken (should now be fixed to properly read most ASCII columnar data)
  • Fixes #651 Documentation on how to write new style models added
  • Fixes #654 Problem saving projects (should now work again as it used to).

Current Known Issues

Critical - will be fixed in a bug release due imminently:

  • As part of the model structure refactoring a new bug was introduced that makes P * S unusable in this version unless the background is fixed to zero: The background is multiplied by P(q) including all the scaling factors. Release 4.0.1 should be available soon that fixes this.

Other Significant - will be fixed in 4.1:

  • The compute button does not always compute. For those who enter return after changing a parameter value this will never come into play as enter after a change will recompute. NOTE hitting compute then enter without a change will not work. The user will need to enter something in a parameter box after hitting the compute button and then hit enter.
  • Projects/fits saved in previous version of SasView will not load correctly in 4.0 due to the changes in the models infrastructure. Release 4.1 will mostly restore backwards compatibility along with improvements in the save and load projects infrastructure.

Model issues - Corrections will be posted to Marketplace as available (and fixed in following release):

  • Core shell parrallelipiped fails to calculate the long (C side) shell. If set non-zero this leads to an incorrect volume normalization and thus to an incorrect absolute scaling. This has apparently always been true. If thick_C is set to zero the model behaves correctly.
  • The 2D FCC paracrystal model is incorrect (it calculates a BCC). The 1D is however correct.
  • The Stacked Disk model only calculates 1 stack (i.e. n_stacking is ignored). This is apparently a long standing issue. Also 2D version is not currently available.
  • Non integer number of pearls is not handled properly in pearl necklace model. This is a long standing issue

Bug Reporting

Please support the project by reporting bugs that you find to [email protected]

All the known bugs/feature requests can be found at: http://trac.sasview.org/report/3

Regular developer builds are also available from https://jenkins.esss.dk/sasview/ if you wish to test the very latest (most likely unstable) versions of SasView.

[This release makes use of sasmodels v0.94]