Changes between Version 6 and Version 7 of ModelConvInst

Timestamp:

Nov 3, 2015 8:16:07 PM (9 years ago)

Author:

pkienzle

Comment:

—

ModelConvInst

@@ -34 +34 @@
  - exp = exponent (example: porod_exp)
  - peak_pos = q_peak or q0 etc
- - lower and upper limits can be any number or -inf or inf
+ - lower and upper limits can be any number or -inf or inf (the limits will show up as the default limits for the fit, making it easy for example to force the radius to always be greater than zero)
  - type can take 3 values at this time: “”, “volume”, or “orientation”
 - COMPUTATION
@@ -41 +41 @@
   - def Iqxy.  If this model does not have an oriented form just set it equal to the square root of the sum of Iq(x) squared and Iq(y) squared.
  - Python + C
-  - in place of the above methods point to the C source files needed.  There should be 3: two libraries and the model.c where model is the same name as given to the python model.py it should read source = ["lib/J1.c", "lib/gauss76.c", "my_model.c"]
+  - common functions should be moved into their own file, such as lib/J1.c for the bessel function J1.
+  - in place of the above methods point to the C source files needed. This will be a list of any lib files needed, followed by the model.c file, where model is the same name as given to the python model.py.  For example:
+  {{{#!python
+      source = ["lib/J1.c", "lib/gauss76.c", "my_model.c"]
+  }}}
   - the c file must contain the Iq and Iqxy methods.  These and any other functions defined (e.g. form_volume, radius, etc) must be defined as doubles in the first lines of the file.
 - For certain models, such as those that can be multiplied by a structure factor, the ER attribute should be set to the Equivalent Radius (of a sphere).
 - For certain models, namely core shell type models, the VR attribute returns the volume ratio for the core-shell.
 - demo is a dictionary containing the value of each parameter as given in the rst documentation.  Make sure to enter the appropriate values from that documentation.  This will then be used to generate the example curve in said documentation.
-- oldname is the name for this model used in !SasView.  Make sure to put the correct original name.  This is required for the transition to allow compatibility.
+- oldname is the name for this model used in !SasView.  Make sure to put the correct original name.  This is required for the transition to allow compatibility and to test that the models are equivalent.
 - oldpars is the name of the parameters as used in !SasView.  For each parameter give the name of the parameter as used in the original !SasView code version of this model.  Again this is required for the transition.
 - tests section (for unit test purposes) VERY IMPORTANT.  Syntax: test is a list of lists. each list is one test and contains, in order, 
  - a dictionary of parameter values. This can be {} using the default parameters, or filled with some parameters that will be different from the default ({‘radius’:10.0, ‘sld’:4}) unlisted parameters will be given the default values.
- - the q value or a tuple of qx, qy values
- - the Iq or Iqxy expected of the model for the parameters and q value given.  There should be at least one test in the list.  Please make sure that the answer value is correct (i.e. not a random number please) 
+ - the input q value or tuple of qx, qy values 
+ - the output Iq or Iqxy expected of the model for the parameters and q value given
+ - inputs and outputs can also be lists if you have several values to test for the same model parameters
+ - for ER and VR, give the inputs as 'ER' and 'VR' respectively
+ - include at least one test for each model.  Please make sure that the answer value is correct (i.e. not a random number please)
+ - to summarize:
+{{{#!python
+    tests = [
+        [ {parameters}, q, I(q)],
+        [ {parameters}, [q], [I(q)] ],
+        [ {parameters}, [q1, q2, ...], [I(q1), I(q2), ...]],
+        [ {parameters}, (qx, qy), I(qx, Iqy)],
+        [ {parameters}, [(qx1, qy1), (qx2, qy2), ...],
+                        [I(qx1,qy1), I(qx2,qy2), ...]],
+        [ {parameters}, 'ER', ER(pars) ],
+        [ {parameters}, 'VR', VR(pars) ],
+    ]
+}}} 
+    where 
+{{{#!python
+    parameters = {'k1': v1, 'k2': v2, ...}
+}}}
 
 '''TEST YOUR NEWLY CONVERTED MODEL'''