Changeset 40a87fa in sasmodels for sasmodels/modelinfo.py

Timestamp:

Aug 8, 2016 9:24:11 AM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

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:

2472141

Parents:

2d65d51

Message:

lint and latex cleanup

File:

• sasmodels/modelinfo.py (modified) (10 diffs)

sasmodels/modelinfo.py

@@ -46 +46 @@
 ]
 assert (len(COMMON_PARAMETERS) == 2
-        and COMMON_PARAMETERS[0][0]=="scale"
-        and COMMON_PARAMETERS[1][0]=="background"), "don't change common parameters"
+        and COMMON_PARAMETERS[0][0] == "scale"
+        and COMMON_PARAMETERS[1][0] == "background"), "don't change common parameters"
 
 
@@ -131 +131 @@
 
     # automatically identify sld types
-    if ptype== '' and (pid.startswith('sld') or pid.endswith('sld')):
+    if ptype == '' and (pid.startswith('sld') or pid.endswith('sld')):
         ptype = 'sld'
 
@@ -182 +182 @@
         scalars = dict((name, value) for name, value in pars.items()
                        if name not in lookup or lookup[name].length == 1)
-        vectors = dict((name,value) for name,value in pars.items()
+        vectors = dict((name, value) for name, value in pars.items()
                        if name in lookup and lookup[name].length > 1)
         #print("lookup", lookup)
@@ -199 +199 @@
                     # supoprt for the form
                     #    dict(thickness=[20,10,3])
-                    for (k,v) in enumerate(value):
+                    for (k, v) in enumerate(value):
                         scalars[name+str(k+1)] = v
         result.update(scalars)
@@ -275 +275 @@
 
     * *relative_pd* is true if that polydispersity is a portion of the
-    value (so a 10% length dipsersity would use a polydispersity value of 0.1)
-    rather than absolute dispersisity (such as an angle plus or minus
-    15 degrees).
+      value (so a 10% length dipsersity would use a polydispersity value
+      of 0.1) rather than absolute dispersisity (such as an angle plus or
+      minus 15 degrees).
 
     *choices* is the option names for a drop down list of options, as for
@@ -325 +325 @@
     def as_function_argument(self):
         # type: () -> str
-        """
+        r"""
         Declare the variable as a function argument.
 
         For example, the parameter thickness with length 3 will
-        return "double *thickness", with no spaces before and
+        return "double \*thickness", with no spaces before and
         no comma afterward.
         """
@@ -370 +370 @@
 
     * *kernel_parameters* is the list of parameters in the kernel parameter
-    table, with vector parameter p declared as p[].
+      table, with vector parameter p declared as p[].
 
     * *iq_parameters* is the list of parameters to the Iq(q, ...) function,
-    with vector parameter p sent as p[].
+      with vector parameter p sent as p[].
 
     * *iqxy_parameters* is the list of parameters to the Iqxy(qx, qy, ...)
-    function, with vector parameter p sent as p[].
+      function, with vector parameter p sent as p[].
 
     * *form_volume_parameters* is the list of parameters to the form_volume(...)
-    function, with vector parameter p sent as p[].
+      function, with vector parameter p sent as p[].
 
     Problem details, which sets up the polydispersity loops, requires the
@@ -385 +385 @@
 
     * *theta_offset* is the offset of the theta parameter in the kernel parameter
-    table, with vector parameters counted as n individual parameters
-    p1, p2, ..., or offset is -1 if there is no theta parameter.
+      table, with vector parameters counted as n individual parameters
+      p1, p2, ..., or offset is -1 if there is no theta parameter.
 
     * *max_pd* is the maximum number of polydisperse parameters, with vector
-    parameters counted as n individual parameters p1, p2, ...  Note that
-    this number is limited to sasmodels.modelinfo.MAX_PD.
+      parameters counted as n individual parameters p1, p2, ...  Note that
+      this number is limited to sasmodels.modelinfo.MAX_PD.
 
     * *npars* is the total number of parameters to the kernel, with vector
-    parameters counted as n individual parameters p1, p2, ...
+      parameters counted as n individual parameters p1, p2, ...
 
     * *call_parameters* is the complete list of parameters to the kernel,
-    including scale and background, with vector parameters recorded as
-    individual parameters p1, p2, ...
+      including scale and background, with vector parameters recorded as
+      individual parameters p1, p2, ...
 
     * *active_1d* is the set of names that may be polydisperse for 1d data
@@ -406 +406 @@
     the scale and background parameters that the kernel does not see.  User
     parameters don't use vector notation, and instead use p1, p2, ...
-
     """
     # scale and background are implicit parameters
@@ -830 +829 @@
     #: form of "section" or "section:subsection".  So for example,
     #: :ref:`porod` uses *category="shape-independent"* so it is in the
-    #: :ref:`Shape-independent` section whereas
-    #: :ref:`capped_cylinder` uses: *category="shape:cylinder"*, which puts
+    #: :ref:`shape-independent` section whereas
+    #: :ref:`capped-cylinder` uses: *category="shape:cylinder"*, which puts
     #: it in the :ref:`shape-cylinder` section.
     category = None         # type: Optional[str]
     #: True if the model can be computed accurately with single precision.
-    #: This is True by default, but models such as :ref:`bcc_paracrystal` set
+    #: This is True by default, but models such as :ref:`bcc-paracrystal` set
     #: it to False because they require double precision calculations.
     single = None           # type: bool