Changeset 304c775 in sasmodels for doc


Ignore:
Timestamp:
Oct 25, 2018 5:35:06 PM (6 years ago)
Author:
Paul Kienzle <pkienzle@…>
Branches:
master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests
Children:
39a06c9
Parents:
6d5601c
Message:

provide method for testing Fq results. Refs #1202.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/guide/plugin.rst

    r31fc4ad r304c775  
    10331033          "radius": 120., "radius_pd": 0.2, "radius_pd_n":45}, 
    10341034         0.2, 0.228843], 
    1035         [{"radius": 120., "radius_pd": 0.2, "radius_pd_n":45}, "ER", 120.], 
    1036         [{"radius": 120., "radius_pd": 0.2, "radius_pd_n":45}, "VR", 1.], 
     1035        [{"radius": 120., "radius_pd": 0.2, "radius_pd_n":45}, 
     1036         0.1, None, None, 120., None, 1.],  # q, F, F^2, R_eff, V, form:shell 
    10371037    ] 
    10381038 
    10391039 
    1040 **tests=[[{parameters}, q, result], ...]** is a list of lists. 
     1040**tests=[[{parameters}, q, Iq], ...]** is a list of lists. 
    10411041Each list is one test and contains, in order: 
    10421042 
     
    10501050- input and output values can themselves be lists if you have several 
    10511051  $q$ values to test for the same model parameters. 
    1052 - for testing *ER* and *VR*, give the inputs as "ER" and "VR" respectively; 
    1053   the output for *VR* should be the sphere/shell ratio, not the individual 
    1054   sphere and shell values. 
     1052- for testing effective radius, volume and form:shell volume ratio, use the 
     1053  extended form of the tests results, with *None, None, R_eff, V, V_r* 
     1054  instead of *Iq*.  This calls the kernel *Fq* function instead of *Iq*. 
     1055- for testing F and F^2 (used for beta approximation) do the same as the 
     1056  effective radius test, but include values for the first two elements, 
     1057  $<F(q)>$ and $<F^2(q)>$. 
    10551058 
    10561059.. _Test_Your_New_Model: 
Note: See TracChangeset for help on using the changeset viewer.