Changeset ce8bed9 in sasmodels

Timestamp:

Mar 19, 2016 3:59:05 PM (8 years ago)

Author:

richardh

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

bad8b12

Parents:

aa24114

Message:

tidy docs and rename solvent_sld

Location:

sasmodels/models

Files:

• flexible_cylinder.py (modified) (1 diff)
• flexible_cylinder_ex.py (modified) (8 diffs)

sasmodels/models/flexible_cylinder.py

@@ -32 +32 @@
 The returned value is in units of $cm^{-1}$, on absolute scale.
 
-In the parameters, the sldCyl and sldSolv represent the SLD of the chain/cylinder
+In the parameters, the sld and sld\_solvent represent the SLD of the cylinder
 and solvent respectively.
 

sasmodels/models/flexible_cylinder_ex.py

@@ -24 +24 @@
 -----------
 
-The function calculated is from the reference given below. From that paper,
-"Method 3 With Excluded Volume" is used.
+The function calculated in a similar way to that for the flexible_cylinder model
+from the reference given below using the author's "Method 3 With Excluded Volume".
 The model is a parameterization of simulations of a discrete representation of
 the worm-like chain model of Kratky and Porod applied in the pseudo-continuous
@@ -62 +62 @@
 maintain this inequality.
 
-The returned value is in units of $cm^-1$, on absolute scale.
+The returned value is in units of $cm^{-1}$, on absolute scale.
 
-In the parameters, the $sldCyl$ and $sldSolv$ represent the SLD of the
+In the parameters, the $sld$ and $sld\_solvent$ represent the SLD of the
 chain/cylinder and solvent respectively. The *scale*, and the contrast are both
 multiplicative factors in the model and are perfectly correlated. One or both of
@@ -103 +103 @@
     ["kuhn_length", "Ang",        100.0, [0, inf],    "volume", "Kuhn length of the flexible cylinder"],
     ["radius",      "Ang",         20.0, [0, inf],    "volume", "Radius of the flexible cylinder"],
-    ["axis_ratio",  "",             1.5, [0, inf],    "",       "Axis_ratio (major_radius/radius"],
+    ["axis_ratio",  "",             1.5, [0, inf],    "",       "Axis_ratio (major_radius/minor_radius"],
     ["sld",         "1e-6/Ang^2",   1.0, [-inf, inf], "",       "Cylinder scattering length density"],
-    ["solvent_sld", "1e-6/Ang^2",   6.3, [-inf, inf], "",       "Solvent scattering length density"],
+    ["sld_solvent", "1e-6/Ang^2",   6.3, [-inf, inf], "",       "Solvent scattering length density"],
     ]
 # pylint: enable=bad-whitespace, line-too-long
@@ -117 +117 @@
             axis_ratio=1.5,
             sld=1.0,
-            solvent_sld=6.3)
+            sld_solvent=6.3)
 
 oldname = 'FlexCylEllipXModel'
-oldpars = dict(sld='sldCyl', solvent_sld='sldSolv')
+oldpars = dict(sld='sldCyl', sld_solvent='sldSolv')
 
 
@@ -131 +131 @@
     #  'axis_ratio':    1.5,
     #  'sld':           1.0,
-    #  'solvent_sld':   6.3,
+    #  'sld_solvent':   6.3,
     #  'background':    0.0001,
     # }, 0.001, 3509.2187],
@@ -141 +141 @@
       'axis_ratio':    1.5,
       'sld':           1.0,
-      'solvent_sld':   6.3,
+      'sld_solvent':   6.3,
       'background':    0.0001,
      }, 1.0, 0.00223819],
@@ -149 +149 @@
       'axis_ratio':    0.5,
       'sld':           6.0,
-      'solvent_sld':  12.3,
+      'sld_solvent':  12.3,
       'background':    0.001,
      }, 0.1, 0.390281],
@@ -157 +157 @@
       'axis_ratio':    4.5,
       'sld':           0.1,
-      'solvent_sld':   5.1,
+      'sld_solvent':   5.1,
       'background':    0.0,
      }, 1.0, 0.0016338264790]