pyscript_utils

Collaboration diagram for pyscript_utils:

Functions
def	pyscript_utils.create_input_dict (deterministic_dict, parametric_input)
	This function returns a dictionary containing the input values to be used in the computation code. More...
def	pyscript_utils.create_normal_parametric_output (output_dict, parametric_input)
	This function returns a dictionary describing the output of the computation code in parametric studies. More...
def	pyscript_utils.create_error_parametric_output (error_message)
	This function returns a dictionary describing the output of the computation code in parametric studies in case of error. More...
def	KERNEL_PY.kernel.parametric.pyscript_utils.create_input_dict (deterministic_dict, parametric_input)
	This function returns a dictionary containing the input values to be used in the computation code. More...
def	KERNEL_PY.kernel.parametric.pyscript_utils.create_normal_parametric_output (output_dict, parametric_input)
	This function returns a dictionary describing the output of the computation code in parametric studies. More...
def	KERNEL_PY.kernel.parametric.pyscript_utils.create_error_parametric_output (error_message)
	This function returns a dictionary describing the output of the computation code in parametric studies in case of error. More...

Detailed Description

This module provides utility functions for the computation codes intended for use in parametric studies. The computation codes must be implemented as a Python script or function to use these functions. If the computation code is implemented as a SALOME component, use module salome.kernel.parametric.compo_utils instead.

Function Documentation

create_error_parametric_output() [1/2]

def pyscript_utils.create_error_parametric_output

(

error_message

)

This function returns a dictionary describing the output of the computation code in parametric studies in case of error.

Parameters

error_message

(string) the error message.

Returns

a dictionary describing the error.

create_error_parametric_output() [2/2]

def KERNEL_PY.kernel.parametric.pyscript_utils.create_error_parametric_output

(

error_message

)

This function returns a dictionary describing the output of the computation code in parametric studies in case of error.

Parameters

error_message

(string) the error message.

Returns

a dictionary describing the error.

This function returns a dictionary describing the output of the
computation code in parametric studies in case of error.

:type  error_message: string
:param error_message: the error message.

:return: a dictionary describing the error.

create_input_dict() [1/2]

def pyscript_utils.create_input_dict	(		deterministic_dict,
			parametric_input
	)

This function returns a dictionary containing the input values to be used in the computation code.

Parameters

deterministic_dict	(dict) dictionary containing the fixed values (i.e. non-parametric). This dictionary can be empty if all variables are parametric.
parametric_input	(dict) dictionary containing the description and values of the parametric variables.

Returns

a dictionary containing the input values for the computation code.

create_input_dict() [2/2]

def KERNEL_PY.kernel.parametric.pyscript_utils.create_input_dict	(		deterministic_dict,
			parametric_input
	)

This function returns a dictionary containing the input values to be used in the computation code.

Parameters

deterministic_dict	(dict) dictionary containing the fixed values (i.e. non-parametric). This dictionary can be empty if all variables are parametric.
parametric_input	(dict) dictionary containing the description and values of the parametric variables.

Returns

a dictionary containing the input values for the computation code.

This function returns a dictionary containing the input values to be used
in the computation code.

:type  deterministic_dict: dict
:param deterministic_dict: dictionary containing the fixed values (i.e.
                           non-parametric). This dictionary can be empty
                           if all variables are parametric.

:type  parametric_input: dict
:param parametric_input: dictionary containing the description and values
                         of the parametric variables.

:return: a dictionary containing the input values for the computation code.

create_normal_parametric_output() [1/2]

def pyscript_utils.create_normal_parametric_output	(		output_dict,
			parametric_input
	)

This function returns a dictionary describing the output of the computation code in parametric studies.

Parameters

output_dict	(dict) dictionary containing the output values of the computation code (the keys are the variable names, the values are the variable values).
parametric_input	(dict) dictionary containing the description and values of the parametric variables.

Returns

a dictionary containing the representation of the output of the computation code.

create_normal_parametric_output() [2/2]

def KERNEL_PY.kernel.parametric.pyscript_utils.create_normal_parametric_output	(		output_dict,
			parametric_input
	)

This function returns a dictionary describing the output of the computation code in parametric studies.

Parameters

output_dict	(dict) dictionary containing the output values of the computation code (the keys are the variable names, the values are the variable values).
parametric_input	(dict) dictionary containing the description and values of the parametric variables.

Returns

a dictionary containing the representation of the output of the computation code.

This function returns a dictionary describing the output of the
computation code in parametric studies.

:type  output_dict: dict
:param output_dict: dictionary containing the output values of the
                    computation code (the keys are the variable names, the
                    values are the variable values).

:type  parametric_input: dict
:param parametric_input: dictionary containing the description and values
                         of the parametric variables.

:return: a dictionary containing the representation of the output of the
         computation code.