kappa_sdk.kw.ModelParser#

class kappa_sdk.kw.ModelParser(xml_string)[source]#

Performs various operations with XML representation of KW models

Methods

ModelParser.add_improve_parameter(...[, ...])

ModelParser.add_model_description_element(...)

ModelParser.export()

ModelParser.get_improve_parameter_targets(...)

ModelParser.get_improve_parameter_value(...)

ModelParser.get_metadata(analysis_id)

ModelParser.get_model_description_value(...)

ModelParser.get_parameter_value(analysis_id, ...)

ModelParser.include_or_exclude_parameter_for_improve(...)

ModelParser.remove_analysis(analysis_id)

ModelParser.remove_model_description(analyses_id)

ModelParser.set_improve_dt_start(...)

ModelParser.set_improve_parameter_targets(...)

ModelParser.set_improve_parameter_value(...)

ModelParser.set_model_description_value(...)

ModelParser.set_model_parameter_improve_value(...)

ModelParser.set_parameter_value(analysis_id, ...)

Parameters:

xml_string (str)

__init__(xml_string)[source]#
Parameters:

xml_string (str)

Return type:

None

get_parameter_value(analysis_id, xml_parameter_locator)[source]#
Parameters:
Return type:

str

set_parameter_value(analysis_id, xml_parameter_locator, value)[source]#
Parameters:

  • analysis_id (str)

  • xml_parameter_locator (ModelParameter)

  • value (str)

Return type:

None

add_model_description_element(analysis_id, parameter_name, sub_parameter_name, parameter_value, position=0)[source]#
Parameters:

  • analysis_id (str)

  • parameter_name (str)

  • sub_parameter_name (str)

  • parameter_value (str)

  • position (int)

Return type:

None

add_improve_parameter(analysis_id, parameter_name, parameter_value, position=0)[source]#
Parameters:

  • analysis_id (str)

  • parameter_name (str)

  • parameter_value (str)

  • position (int)

Return type:

None

get_model_description_value(analysis_id, parameter_name, sub_parameter_name=None)[source]#
Parameters:

  • analysis_id (str)

  • parameter_name (str)

  • sub_parameter_name (str | None)

Return type:

str

set_model_description_value(analysis_id, parameter_name, sub_parameter_name, value)[source]#
Parameters:

  • analysis_id (str)

  • parameter_name (str)

  • sub_parameter_name (str | None)

  • value (str)

Return type:

None

get_improve_parameter_value(analysis_id, parameter_name, sub_parameter_name=None)[source]#
Parameters:

  • analysis_id (str)

  • parameter_name (str)

  • sub_parameter_name (str | None)

Return type:

str | None

set_improve_parameter_value(analysis_id, parameter_name, sub_parameter_name, value)[source]#
Parameters:

  • analysis_id (str)

  • parameter_name (str)

  • sub_parameter_name (str)

  • value (bool | str)

Return type:

None

set_model_parameter_improve_value(analysis_id, parameter, improve_parameter_name, value)[source]#
Parameters:

  • analysis_id (str)

  • parameter (ModelParameter)

  • improve_parameter_name (str)

  • value (str)

Return type:

None

get_improve_parameter_targets(analysis_id)[source]#
Parameters:

analysis_id (str)

Return type:

List[ImproveTarget]

set_improve_parameter_targets(analysis_id, improve_parameter_targets)[source]#
Parameters:

  • analysis_id (str)

  • improve_parameter_targets (List[ImproveTarget])

Return type:

None

set_improve_dt_start(analysis_id, dt_start)[source]#
Parameters:

  • analysis_id (str)

  • dt_start (float)

Return type:

None

export()[source]#
Return type:

str

include_or_exclude_parameter_for_improve(analysis_id, parameter_name, is_included, conditions)[source]#
Parameters:

  • analysis_id (str)

  • parameter_name (str)

  • is_included (bool)

  • conditions (Dict[Any, Any] | None)

Return type:

None

remove_analysis(analysis_id)[source]#
Parameters:

analysis_id (str)

Return type:

None

get_metadata(analysis_id)[source]#
Parameters:

analysis_id (str)

Return type:

Dict[str, str]

remove_model_description(analyses_id)[source]#
Parameters:

analyses_id (List[str])

Return type:

None