Changeset 79ac6f8 in sasview for sansmodels/src/sans/models/c_models/modelTemplate.txt

Timestamp:

Jun 4, 2010 3:04:49 PM (14 years ago)

Author:

Gervaise Alina <gervyh@…>

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:

5062bbf

Parents:

7116b6e0

Message:

working on documentation

File:

• sansmodels/src/sans/models/c_models/modelTemplate.txt (modified) (6 diffs)

sansmodels/src/sans/models/c_models/modelTemplate.txt

@@ -1 +1 @@
 #!/usr/bin/env python
-"""
-        This software was developed by the University of Tennessee as part of the
-        Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
-        project funded by the US National Science Foundation.
 
-        If you use DANSE applications to do scientific research that leads to
-        publication, we ask that you acknowledge the use of the software with the
-        following sentence:
+##############################################################################
+#       This software was developed by the University of Tennessee as part of the
+#       Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
+#       project funded by the US National Science Foundation.
+#
+#       If you use DANSE applications to do scientific research that leads to
+#       publication, we ask that you acknowledge the use of the software with the
+#       following sentence:
+#
+#       "This work benefited from DANSE software developed under NSF award DMR-0520547."
+#
+#       copyright 2008, University of Tennessee
+##############################################################################
 
-        "This work benefited from DANSE software developed under NSF award DMR-0520547."
 
-        copyright 2008, University of Tennessee
-"""
+""" 
+Provide functionality for a C extension model
 
-""" 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
 
 """
@@ -27 +30 @@
     
 class [PYTHONCLASS]([CPYTHONCLASS], BaseComponent):
-    """ Class that evaluates a [PYTHONCLASS] model. 
-        This file was auto-generated from [INCLUDE_FILE].
-        Refer to that file and the structure it contains
-        for details of the model.
-        [DEFAULT_LIST]
+    """ 
+    Class that evaluates a [PYTHONCLASS] model. 
+    This file was auto-generated from [INCLUDE_FILE].
+    Refer to that file and the structure it contains
+    for details of the model.
+    [DEFAULT_LIST]
     """
         
@@ -58 +62 @@
         
     def __getstate__(self):
-        """ return object state for pickling and copying """
+        """
+        return object state for pickling and copying
+        """
         model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
         
@@ -64 +70 @@
         
     def __setstate__(self, state):
-        """ create object from pickled state """
+        """
+        create object from pickled state
+        
+        :param state: the state of the current model
+        
+        """
         
         self.__dict__, model_state = state
@@ -72 +83 @@
         
    
-    def run(self, x = 0.0):
-        """ Evaluate the model
-            @param x: input q, or [q,phi]
-            @return: scattering function P(q)
+    def run(self, x=0.0):
+        """ 
+        Evaluate the model
+        
+        :param x: input q, or [q,phi]
+        
+        :return: scattering function P(q)
+        
         """
         
         return [CPYTHONCLASS].run(self, x)
    
-    def runXY(self, x = 0.0):
-        """ Evaluate the model in cartesian coordinates
-            @param x: input q, or [qx, qy]
-            @return: scattering function P(q)
+    def runXY(self, x=0.0):
+        """ 
+        Evaluate the model in cartesian coordinates
+        
+        :param x: input q, or [qx, qy]
+        
+        :return: scattering function P(q)
+        
         """
         
         return [CPYTHONCLASS].runXY(self, x)
         
-    def evalDistribution(self, x = []):
-        """ Evaluate the model in cartesian coordinates
-            @param x: input q[], or [qx[], qy[]]
-            @return: scattering function P(q[])
+    def evalDistribution(self, x=[]):
+        """ 
+        Evaluate the model in cartesian coordinates
+        
+        :param x: input q[], or [qx[], qy[]]
+        
+        :return: scattering function P(q[])
+        
         """
         return [CPYTHONCLASS].evalDistribution(self, x)
         
     def calculate_ER(self):
-        """ Calculate the effective radius for P(q)*S(q)
-            @return: the value of the effective radius
+        """ 
+        Calculate the effective radius for P(q)*S(q)
+        
+        :return: the value of the effective radius
+        
         """       
         return [CPYTHONCLASS].calculate_ER(self)
@@ -103 +129 @@
     def set_dispersion(self, parameter, dispersion):
         """
-            Set the dispersion object for a model parameter
-            @param parameter: name of the parameter [string]
-            @dispersion: dispersion object of type DispersionModel
+        Set the dispersion object for a model parameter
+        
+        :param parameter: name of the parameter [string]
+        :param dispersion: dispersion object of type DispersionModel
+        
         """
         return [CPYTHONCLASS].set_dispersion(self, parameter, dispersion.cdisp)