Changeset e65a3e7 in sasmodels for sasmodels/models/flexible_cylinder.py

Timestamp:

Mar 19, 2016 5:37:29 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:

aa24114

Parents:

81d3a0c

Message:

tidy docs and renam solvent_sld

File:

• sasmodels/models/flexible_cylinder.py (modified) (9 diffs)

sasmodels/models/flexible_cylinder.py

@@ -30 +30 @@
 The Kuhn length $(b = 2*l_p)$ is also used to describe the stiffness of a chain.
 
-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 chain/cylinder
@@ -65 +65 @@
 title = "Flexible cylinder where the form factor is normalized by the volume" \
         "of the cylinder."
-description = """Note : scale and contrast=sld-solvent_sld are both
+description = """Note : scale and contrast = (sld - sld_solvent) are both
                 multiplicative factors in the model and are perfectly
                 correlated. One or both of these parameters must be held fixed
@@ -72 +72 @@
 
 category = "shape:cylinder"
-single = False
+single = False  # double precision only!
 
 # pylint: disable=bad-whitespace, line-too-long
@@ -81 +81 @@
     ["radius",      "Ang",         20.0, [0, inf],    "volume", "Radius of the flexible cylinder"],
     ["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
@@ -91 +91 @@
             radius=20.0,
             sld=1.0,
-            solvent_sld=6.3)
+            sld_solvent=6.3)
 
 oldname = 'FlexibleCylinderModel'
-oldpars = dict(sld='sldCyl', solvent_sld='sldSolv')
+oldpars = dict(sld='sldCyl', sld_solvent='sldSolv')
 
 
@@ -104 +104 @@
     #  'radius':       20.0,
     #  'sld':           1.0,
-    #  'solvent_sld':   6.3,
+    #  'sld_solvent':   6.3,
     #  'background':    0.0001,
     #  }, 0.001, 3509.2187],
@@ -113 +113 @@
       'radius':       20.0,
       'sld':           1.0,
-      'solvent_sld':   6.3,
+      'sld_solvent':   6.3,
       'background':    0.0001,
      }, 1.0, 0.000595345],
@@ -120 +120 @@
       'radius':        2.0,
       'sld':           6.0,
-      'solvent_sld':  12.3,
+      'sld_solvent':  12.3,
       'background':    0.001,
      }, 0.1, 1.55228],
@@ -127 +127 @@
       'radius':       50.0,
       'sld':           0.1,
-      'solvent_sld':   5.1,
+      'sld_solvent':   5.1,
       'background':    0.0,
      }, 1.0, 0.000938456]