Changes in / [0dde203:d620d03c] in sasview


Ignore:
Files:
6 added
6 edited

Legend:

Unmodified
Added
Removed

  • INSTALL.txt

    r26c9b85 re40390ee  
    4747More information can be found here: 
    4848 
    49 http://www.sasview.org/help.html 
    50 http://www.sasview.org/faq.html 
     49http://www.sasview.org/help/ 
     50http://www.sasview.org/faq/ 
    5151http://www.sasview.org/trac/wiki/DevNotes 

  • docs/sphinx-docs/source/user/RELEASE.rst

    r8514f89 r2c355a2  
    156156* Fixes # 784: Add 3D integral to Correlation Function analysis 
    157157* Fixes # 786: core_shell_parallelepiped 1-D model is incorrect 
    158 * Fixes # 818: “report button” followed by “save” makes an empty pdf file??? 
     158* Fixes # 818: "report button" followed by "save" makes an empty pdf file??? 
    159159* Fixes # 830: Check compliance of loader against NXcanSAS-1.0 release 
    160160* Fixes # 838: Fix model download from marketplace 
    … …  
    770770          that any previous versions of SasView are uninstalled prior to  
    771771          installing the new version UNLESS you are installing SasView to  
    772           versioned folders. 
     772          versioned folders. **We recommend you avoid using folder paths  
     773          that contain spaces or characters that cannot be found on a  
     774          standard keyboard (eg, characters with accents, umlauts, etc).** 
    773775 
    774776.. note:: The easiest approach to setting up the proper environment to 
    … …  
    965967Frequently Asked Questions 
    966968========================== 
    967 http://www.sasview.org/faq.html 
     969http://www.sasview.org/faq/ 
    968970 
    969971 

  • src/sas/sasgui/perspectives/fitting/media/fitting.rst

    rc926a97 r332c10d  
    1717   Smearing Functions <resolution> 
    1818 
     19   Fitting Models with Structure Factors <fitting_sq> 
     20 
     21   Writing a Plugin Model <plugin> 
     22 
    1923   Polarisation/Magnetic Scattering <magnetism/magnetism> 
    20     
     24 
    2125   Oriented Particles <orientation/orientation> 
    2226 
    … …  
    2731   Fitting SESANS Data <sesans/sesans_fitting> 
    2832 
    29    Writing a Plugin Model <plugin> 
    30  
    3133   Computations with a GPU <gpu_setup> 
    3234 

  • src/sas/sasgui/perspectives/fitting/media/fitting_help.rst

    r8b89396 rfa307dd  
    4242*  *Ellipsoid* - ellipsoidal shapes (oblate,prolate, core shell, etc) 
    4343*  *Parellelepiped* - as the name implies 
    44 *  *Sphere* - sheroidal shapes (sphere, core multishell, vesicle, etc) 
     44*  *Sphere* - spheroidal shapes (sphere, core multishell, vesicle, etc) 
    4545*  *Lamellae* - lamellar shapes (lamellar, core shell lamellar, stacked 
    4646   lamellar, etc) 
    … …  
    6161on the *Description* button to the right. 
    6262 
     63Product Models 
     64^^^^^^^^^^^^^^ 
     65 
     66S(Q) models can be combined with many models in the other categories to 
     67generate what SasView calls "product models". The combination can be done by 
     68one of two methods, but how they behave is slightly different. 
     69 
     70The first, most straightforward, method is simply to use the S(Q) drop-down in 
     71the FitPage: 
     72 
     73.. figure:: p_and_s_buttons.png 
     74 
     75This example would then generate a product model with the following parameters: 
     76 
     77.. figure:: p_and_s_buttons_parameters.png 
     78 
     79The other method is to use the :ref:`Sum|Multi(p1,p2)` tool under Fitting > 
     80Plugin Model Operations: 
     81 
     82.. figure:: p_and_s_sum_model.png 
     83 
     84This creates a product model with the following parameters: 
     85 
     86.. figure:: p_and_s_sum_model_parameters.png 
     87 
     88As can be seen, the second method has produced a product model with an extra 
     89parameter: *radius_effective*. This is the radial distance determining the 
     90range of the $S(Q)$ interaction and may, or may not, be the same as the 
     91*radius*, in this example, depending on the concentration of the system. In 
     92other systems, *radius_effective* may depend on the particle form (shape). 
     93 
     94See :ref:`Product_Models` for more information. 
     95 
    6396Show 1D/2D 
    6497^^^^^^^^^^ 
    … …  
    119152 
    120153For a complete list of all the library models available in SasView, see 
    121 the `Model Documentation <../../../index.html>`_ . 
     154the `Model Documentation <../../../sasgui/perspectives/fitting/models/index.html>`_ . 
    122155 
    123156It is also possible to add your own models. 
    … …  
    217250a P(Q) model has been selected). 
    218251 
     252.. _Sum|Multi(p1,p2): 
     253 
    219254Sum|Multi(p1,p2) 
    220255^^^^^^^^^^^^^^^^ 
    … …  
    338373These optimisers form the *Bumps* package written by P Kienzle. For more information 
    339374on each optimiser, see the :ref:`Fitting_Documentation`. 
     375 
     376.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     377 
     378Fitting Integer Parameters 
     379-------------------------- 
     380 
     381Most of the parameters in SasView models will naturally take floating point (decimal)  
     382values, but there are some parameters which can only have integer values. Examples  
     383include, but are not limited to, the number of shells in a multilayer vesicle, the  
     384number of beads in a pearl necklace, the number of arms of a star polymer, and so on. 
     385Wherever possible/recognised, the integer nature of a parameter is specified in the  
     386respective model documentation and/or parameter table, so read the documentation  
     387carefully! 
     388 
     389Integer parameters must be fitted with care. 
     390 
     391Start with your best possible guess for the value of the parameter. And using  
     392*a priori* knowledge, fix as many of the other parameters as possible. 
     393  
     394The SasView optimizers treat integer parameters internally as floating point  
     395numbers, but the values presented to the user are truncated or rounded, as  
     396appropriate. 
     397 
     398In most instances integer parameters will probably be greater than zero. A good  
     399policy in such cases is to use a constraint to enforce this. 
     400 
     401Because an integer parameter should, by definition, only move in integer steps,  
     402problems may be encountered if the optimizer step size is too small. Similarly,  
     403be **very careful** about applying polydispersity to integer parameters. 
     404 
     405The Levenberg-Marquardt and Quasi-Newton BFGS (and other derivative-based)  
     406optimizers are probably best avoided for fitting models with integer parameters. 
    340407 
    341408.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 

  • src/sas/sasview/test/README.txt

    refe730d r1cf0fc0  
    1 Test data sets are included as a convenience to our users. The data sets are organized based on their data structure; 1D data (ie, I(Q)), 2D data (ie, I(Qx,Qy)), coordinate data (eg, PDB files), image data (eg, TIFF files), SasView saved states, SESANS data, and data in formats that are not yet implemented but which are in the works for future releases. 
     1Test data sets are included as a convenience to our users. The data sets are 
     2organized based on their data structure; 1D data (ie, I(Q)), 2D data 
     3(ie, I(Qx,Qy)), coordinate data (eg, PDB files), image data 
     4(eg, TIFF files), SasView saved states, SESANS data, and data in formats that 
     5are not yet implemented but which are in the works for future releases. 
    26 
    3 1D data sets EITHER a) have at least two columns of data with I(abs. units) on the y-axis and Q on the x-axis, OR b) have I and Q in separate files. Data in the latter format (/convertible_files) need to be converted to a single file format with the File Converter tool before SasView will analyse them. 
     71D data sets EITHER a) have at least two columns of data with I(abs. units) on 
     8the y-axis and Q on the x-axis, OR b) have I and Q in separate files. Data in 
     9the latter format (/convertible_files) need to be converted to a single file 
     10format with the File Converter tool before SasView will analyse them. 
    411 
    5 2D data sets are data sets that give the deduced intensity for each detector pixel. Depending on the file extension, uncertainty and metadata may also be available. 
     122D data sets are data sets that give the deduced intensity for each detector 
     13pixel. Depending on the file extension, uncertainty and metadata may also be 
     14available. 
    615 
    7 Coordinate data sets are designed to be read by the Generic Scattering Calculator tool. 
     16Coordinate data sets are designed to be read by the Generic Scattering 
     17Calculator tool. 
    818 
    919Image data sets are designed to be read by the Image Viewer tool. 
    1020 
    11 Save states are projects and analyses saved by the SASVIEW program. A single analysis file contains the data and parameters for a single fit (.fit), p(r) inversion (.pr), or invariant calculation (.inv). A project file (.svs) contains the results for every active analysis. 
     21Save states are projects and analyses saved by the SASVIEW program. A single 
     22analysis file contains the data and parameters for a single fit (.fit), p(r) 
     23inversion (.pr), or invariant calculation (.inv). A project file (.svs) 
     24contains the results for every active analysis. 
    1225 
    13 SESANS data sets primarily contain the neutron polarisation as a function of the spin-echo length. 
     26SESANS data sets primarily contain the neutron polarisation as a function of 
     27the spin-echo length. 
Note: See TracChangeset for help on using the changeset viewer.