Changeset 25836 for issm/trunk/src/m/qmu/dakota_in_data.py

Timestamp:

12/08/20 08:45:53 (4 years ago)

Author:

Mathieu Morlighem

Message:

merged trunk-jpl and trunk for revision 25834

Location:

issm/trunk

Files:

• . (modified) (1 prop)
• src (modified) (1 prop)
• src/m/qmu/dakota_in_data.py (modified) (2 diffs)

issm/trunk/src/m/qmu/dakota_in_data.py

@@ -9 +9 @@
 def dakota_in_data(dmeth, variables, responses, dparams, filei, *args):
     '''
-  define the data to write the dakota .in and .m files.
+    DAKOTA_IN_DATA - define the data to write the dakota .in and .m files.
+    
+    Usage:
+        [] = dakota_in_data(dmeth, variables, responses, dparams, filei, *args)
 
-  [] = dakota_in_data(dmeth, variables, responses, dparams, filei, *args)
+    where the required input is:
+        dmeth         (dakota_method, method class object)
+        variables     (structure array, variable class objects)
+        responses     (structure array, response class objects)
+        dparams       (structure array, method - independent parameters)
+        filei         (character, name of .in and .m files)
 
-  where the required input is:
-    dmeth         (dakota_method, method class object)
-    variables     (structure array, variable class objects)
-    responses     (structure array, response class objects)
-    dparams       (structure array, method - independent parameters)
-    filei         (character, name of .in and .m files)
+    Params may be empty, in which case defaults will be used.
 
-  params may be empty, in which case defaults will be used.
+    The optional args are passed directly through to the QmuUpdateFunctions 
+    brancher to be used by the analysis package. For example, this could be 
+    model information.
 
-  the optional args are passed directly through to the
-  QmuUpdateFunctions brancher to be used by the analysis
-  package.  for example, this could be model information.
+    This function defines the data to write the dakota .in and .m files. It is 
+    necessary for multiple reasons. First, it collects the parameters and 
+    applies some defaults that are unique to the environment. Second, some 
+    analysis package ariables and/or responses may be treated differently by
+    Dakota. For example, an analysis package variable may be defined as an 
+    array, so the QmuSetupDesign brancher will create Dakota variables for each 
+    element of the array. Finally, it calls the functions to write the .in and 
+    .m files. this function is independent of the particular analysis package.
 
-  this function defines the data to write the dakota .in and
-  .m files.  it is necessary for multiple reasons.  first,
-  it collects the parameters and applies some defaults that
-  are unique to the environment.  second, some analysis package
-  variables and / or responses may be treated differently by
-  dakota.  for example, an analysis package variable may be
-  defined as an array, so the QmuSetupDesign brancher will
-  create dakota variables for each element of the array.
-  finally it calls the functions to write the .in and .m files.
-  this function is independent of the particular analysis
-  package.
-
-  this data would typically be generated by a matlab script
-  for a specific model, using the method, variable, and
-  response class objects.
-'''
+    This data would typically be generated by a MATLAB script for a specific 
+    model, using the method, variable, and response class objects.
+    '''
 
     #  parameters
@@ -60 +57 @@
 
     if strcmpi(params.analysis_driver, 'matlab') and params.analysis_components == '':
-        [pathstr, name, ext] = fileparts(filei)
+        pathstr, name, ext = fileparts(filei)
         params.analysis_components = fullfile(pathstr, name + '.py')