Changeset 51f14603 in sasview for src/sans/models

Timestamp:

Apr 3, 2014 11:37:53 AM (10 years ago)

Author:

Peter Parker

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

2f2d9d0

Parents:

eea3ffa

Message:

Refs #202 - Fix Sphinx build errors (not including park-1.2.1/). Most warnings remain.

Location:

src/sans/models

Files:

• BaseComponent.py (modified) (1 diff)
• Constant.py (modified) (1 diff)
• PolymerExclVolume.py (modified) (1 diff)
• PowerLawAbsModel.py (modified) (2 diffs)
• TwoPowerLawModel.py (modified) (1 diff)
• c_extension/python_wrapper/WrapperGenerator.py (modified) (2 diffs)
• c_extension/python_wrapper/modelTemplate.txt (modified) (1 diff)
• qsmearing.py (modified) (1 diff)

src/sans/models/BaseComponent.py

@@ -96 +96 @@
         Evaluate a distribution of q-values.
         
-        * For 1D, a numpy array is expected as input:
+        * For 1D, a numpy array is expected as input: ::
         
             evalDistribution(q)
             
+          where q is a numpy array.
+        
+        
+        * For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime],
+          where 1D arrays, ::
+        
+              qx_prime = [ qx[0], qx[1], qx[2], ....]
+
+          and ::
+
+              qy_prime = [ qy[0], qy[1], qy[2], ....] 
+        
+        Then get ::
+
+            q = numpy.sqrt(qx_prime^2+qy_prime^2)
+        
+        that is a qr in 1D array; ::
+
+            q = [q[0], q[1], q[2], ....] 
+        
+        ..note::
+          Due to 2D speed issue, no anisotropic scattering 
+          is supported for python models, thus C-models should have
+          their own evalDistribution methods.
+        
+        The method is then called the following way: ::
+        
+            evalDistribution(q)
+
         where q is a numpy array.
         
-        
-        * For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime],
-          where 1D arrays,
-        
-        qx_prime = [ qx[0], qx[1], qx[2], ....]
-        and
-        qy_prime = [ qy[0], qy[1], qy[2], ....] 
-        
-        Then get
-        q = numpy.sqrt(qx_prime^2+qy_prime^2)
-        
-        that is a qr in 1D array;
-        q = [q[0], q[1], q[2], ....] 
-        
-        :Note: Due to 2D speed issue, no anisotropic scattering 
-            is supported for python models, thus C-models should have
-             their own evalDistribution methods.
-        
-        The method is then called the following way:
-        
-        evalDistribution(q)
-        where q is a numpy array.
-        
-        :param qdist: ndarray of scalar q-values or list [qx,qy] 
-                    where qx,qy are 1D ndarrays 
-        
+        :param qdist: ndarray of scalar q-values or list [qx,qy] where qx,qy are 1D ndarrays
         """
         if qdist.__class__.__name__ == 'list':

src/sans/models/Constant.py

@@ -7 +7 @@
 
 class Constant(BaseComponent):
-    """ Class that evaluates a constant model. 
-        List of default parameters:
-         value           = 1.0 
+    """
+    Class that evaluates a constant model. 
+    List of default parameters:
+    
+    * value           = 1.0 
     """
         

src/sans/models/PolymerExclVolume.py

@@ -25 +25 @@
     Refer to that file and the structure it contains
     for details of the model.
+
     List of default parameters:
-         scale           = 0.01 
-         rg              = 100.0 [A]
-         m               = 3.0 
-         background      = 0.0 [1/cm]
+    
+    * scale           = 0.01 
+    * rg              = 100.0 [A]
+    * m               = 3.0 
+    * background      = 0.0 [1/cm]
 
     """

src/sans/models/PowerLawAbsModel.py

@@ -1 +1 @@
 """ 
-    Provide F(x) = scale* (|x|)^(-m) + bkd
+    Provide F(x) = scale* (\|x\|)^(-m) + bkd
     Power law function as a BaseComponent model
 """
@@ -8 +8 @@
 class PowerLawAbsModel(PowerLawModel):
     """
-        Class that evaluates a absolute Power_Law model.
-        
+    Class that evaluates a absolute Power_Law model. ::
+    
         F(x) = scale* (|x|)^(-m) + bkd
-        
-        The model has three parameters: 
-            m     =  power
-            scale  =  scale factor
-            bkd    =  incoherent background
+    
+    The model has three parameters:
+
+    * m     =  power
+    * scale  =  scale factor
+    * bkd    =  incoherent background
     """
     

src/sans/models/TwoPowerLawModel.py

@@ -17 +17 @@
         =C*pow(qval,-1.0*power2) for q>qc
     where C=coef_A*pow(qc,-1.0*power1)/pow(qc,-1.0*power2).
+    
     List of default parameters:
-     coef_A = coefficient
-     power1 = (-) Power @ low Q
-     power2 = (-) Power @ high Q
-     qc = crossover Q-value
-     background = incoherent background
+    
+    * coef_A = coefficient
+    * power1 = (-) Power @ low Q
+    * power2 = (-) Power @ high Q
+    * qc = crossover Q-value
+    * background = incoherent background
     """
         

src/sans/models/c_extension/python_wrapper/WrapperGenerator.py

@@ -126 +126 @@
         buf = f.read()
         
-        self.default_list = "List of default parameters:\n"
+        self.default_list = "\n    List of default parameters:\n\n"
         #lines = string.split(buf,'\n')
         lines = buf.split('\n')
@@ -293 +293 @@
                     if len(toks2) >= 2:
                         units = toks2[1]
-                    self.default_list += "         %-15s = %s %s\n" % \
+                    self.default_list += "    * %-15s = %s %s\n" % \
                         (toks[1], val, units)
                     

src/sans/models/c_extension/python_wrapper/modelTemplate.txt

@@ -16 +16 @@
 Provide functionality for a C extension model
 
-:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
-         DO NOT MODIFY THIS FILE, MODIFY
-            [INCLUDE_FILE]
-         AND RE-RUN THE GENERATOR SCRIPT
+.. WARNING::
+
+   THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
+   DO NOT MODIFY THIS FILE, MODIFY
+   [INCLUDE_FILE]
+   AND RE-RUN THE GENERATOR SCRIPT
 """
 

src/sans/models/qsmearing.py

@@ -500 +500 @@
     Make fake data_x points extrapolated outside of the data_x points
     
-    : param width: array of std of q resolution
-    : param Data1D.x: Data1D.x array
-    
-    : return new_width, data_x_ext: extrapolated width array and x array
-    
-    : assumption1: data_x is ordered from lower q to higher q
-    : assumption2: len(data) = len(width)
-    : assumption3: the distance between the data points is more compact 
-            than the size of width 
-    : Todo1: Make sure that the assumptions are correct for Data1D
-    : Todo2: This fixes the edge problem in Qsmearer but still needs to make 
-            smearer interface 
+    :param width: array of std of q resolution
+    :param Data1D.x: Data1D.x array
+    
+    :return new_width, data_x_ext: extrapolated width array and x array
+    
+    :assumption1: data_x is ordered from lower q to higher q
+    :assumption2: len(data) = len(width)
+    :assumption3: the distance between the data points is more compact than the size of width 
+    :Todo1: Make sure that the assumptions are correct for Data1D
+    :Todo2: This fixes the edge problem in Qsmearer but still needs to make smearer interface 
     """
     # Length of the width