Changeset a2f9aa2 in sasmodels for sasmodels/models/pearl_necklace.py

Timestamp:

Mar 21, 2016 10:52:58 AM (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:

7874e80

Parents:

95441ff

Message:

rename sld, check docs etc

File:

• sasmodels/models/pearl_necklace.py (modified) (5 diffs)

sasmodels/models/pearl_necklace.py

@@ -13 +13 @@
 ----------
 
-The output of the scattering intensity function for the PearlNecklaceModel is
+The output of the scattering intensity function for the pearl_necklace is
 given by (Schweins, 2004)
 
@@ -58 +58 @@
 
 name = "pearl_necklace"
-title = "Colloidal spheres chained together with o preferential orientation"
+title = "Colloidal spheres chained together with no preferential orientation"
 description = """
 Calculate form factor for Pearl Necklace Model
@@ -76 +76 @@
 
 #             ["name", "units", default, [lower, upper], "type","description"],
-parameters = [["radius", "Angstrom", 80.0, [0, inf], "volume",
+parameters = [["radius", "Ang", 80.0, [0, inf], "volume",
                "Mean radius of the chained spheres"],
-              ["edge_separation", "Angstrom", 350.0, [0, inf], "volume",
+              ["edge_separation", "Ang", 350.0, [0, inf], "volume",
                "Mean separation of chained particles"],
-              ["string_thickness", "Angstrom", 2.5, [0, inf], "volume",
+              ["string_thickness", "Ang", 2.5, [0, inf], "volume",
                "Thickness of the chain linkage"],
               ["number_of_pearls", "none", 3, [0, inf], "volume",
-               "Mean number of pearls in each necklace"],
-              ["sld", "Angstrom^2", 1.0, [-inf, inf], "",
+               "Number of pearls in the necklace (must be integer)"],
+              ["sld", "1e-6/Ang^2", 1.0, [-inf, inf], "",
                "Scattering length density of the chained spheres"],
-              ["string_sld", "Angstrom^2", 1.0, [-inf, inf], "",
+              ["sld_string", "1e-6/Ang^2", 1.0, [-inf, inf], "",
                "Scattering length density of the chain linkage"],
-              ["solvent_sld", "Angstrom^2", 6.3, [-inf, inf], "",
+              ["sld_solvent", "1e-6/Ang^2", 6.3, [-inf, inf], "",
                "Scattering length density of the solvent"],
              ]
@@ -117 +117 @@
 # parameters for demo
 demo = dict(scale=1, background=0, radius=80.0, edge_separation=350.0,
-            number_of_pearls=3, sld=1, solvent_sld=6.3, string_sld=1,
+            number_of_pearls=3, sld=1, sld_solvent=6.3, sld_string=1,
             string_thickness=2.5,
             radius_pd=.2, radius_pd_n=5,
@@ -129 +129 @@
 oldname = 'PearlNecklaceModel'
 oldpars = dict(scale='scale', background='background', radius='radius',
-               number_of_pearls='num_pearls', solvent_sld='sld_solv',
+               number_of_pearls='num_pearls', sld_solvent='sld_solv',
                string_thickness='thick_string', sld='sld_pearl',
-               string_sld='sld_string', edge_separation='edge_separation')
+               sld_string='sld_string', edge_separation='edge_separation')
 
 tests = [[{}, 0.001, 17380.245], [{}, 'ER', 115.39502]]