nimsos.output_tools package

nimsos.output_tools.analysis_output_standard module

class nimsos.output_tools.analysis_output_standard.Standard(input_file, output_file, num_objectives, output_folder)

Bases: object

Class of Standard

This class can perform analysis of outputs from robot.

extract_objectives(num_objectives, output_folder, p_List)

Extracting objective values from output files by robot

This function DEPENDS on robot.

Parameters

  • num_objectives (int) – the number of objectives

  • output_folder (str) – the folder where the results by machine are stored

  • p_List (list[float]) – the list of proposals

Returns

True for success, False otherwise. o_List (list[float]): the list of objectives

Return type

res (bool)

load_data(input_file)

Loading proposals

This function do not depend on robot.

Parameters

input_file (str) – the file for proposals from MI algorithm

Returns

True for success, False otherwise. p_List (list[float]): list of proposals

Return type

res (bool)

perform()

perfroming analysis of output from robots

This function do not depend on robot.

Returns

True for success, False otherwise.

Return type

res (str)

recieve_exit_message(output_folder)

Recieving exit message from machine

This function DEPENDS on robot.

Parameters

output_folder (str) – the folder where the results by machine are stored

Returns

True for success, False otherwise.

Return type

res (bool)

update_candidate_file(num_objectives, output_file, o_List)

Updating candidates

This function do not depend on robot.

Parameters

  • num_objectives (int) – the number of objectives

  • output_file (str) – the file for candidates

  • o_List (list[float]) – the list of objectives

Returns

True for success, False otherwise.

Return type

res (bool)

nimsos.output_tools.analysis_output_naree module

class nimsos.output_tools.analysis_output_naree.NAREE(input_file, output_file, num_objectives, output_folder, objectives_info)

Bases: object

Class of NAREE

This class can create input file for robot experiments and start the robot experiments.

extract_objectives(num_objectives, output_folder, p_List)

Extracting objective values from output files by robot

This function DEPENDS on robot.

Parameters

  • num_objectives (int) – the number of objectives

  • output_folder (str) – the folder where the results by machine are stored

  • p_List (list[float]) – the list of proposals

Returns

True for success, False otherwise. o_List (list[float]): the list of objectives

Return type

res (bool)

load_data(input_file)

Loading proposals

This function do not depend on robot.

Parameters

input_file (str) – the file for proposals from MI algorithm

Returns

True for success, False otherwise. p_List (list[float]): list of proposals

Return type

res (bool)

objectives_create_SD8(num_objectives, result_folder, output_folder, p_List)
Parameters

  • num_objectives (int) – the number of objectives

  • result_folder (str) – the folder where the results of measurement SD8 stored

  • output_folder (str) – the folder where the results by machine are stored

  • p_List (list[float]) – the list of proposals

Returns

True for success, False otherwise.

Return type

res (bool)

objects_retrieval(chno, measPath)
Parameters

  • chno (int) – Measurement channel number (1 to 96)

  • measPath (str) – Folder containing measurement results

Returns

True for success, False otherwise. objData(list): Measurement results

Return type

res (bool)

perform()

perfroming analysis of output from robots

This function do not depend on robot.

Returns

True for success, False otherwise.

Return type

res (str)

recieve_exit_message()

Recieving exit message from machine

This function DEPENDS on robot.

Returns

True for success, False otherwise.

Return type

res (bool)

resultInput(num, finalVoltage, onecyclesteptime, cou_data, op_data, op_diff_data, maxmin_data)
Parameters

  • num (int) – the number of cycle of SD8 measurements

  • finalVoltage (str) – the final voltage

  • onecyclesteptime (str) – the step time of final discharge mode at 1st cycle

  • cou_data (list) – the Coulombic efficiency for each cycle

  • op_data (list) – the over potential for each cycle

  • op_diff_data (list) – the difference of over potential for each cycle

  • maxmin_data (list) – the maximum/minimum of voltage for each cycle

Returns

the list of objectives shown in Note

Return type

objData(list)

Note

FinalVoltage: Final Voltage

StepCycle: 1cycle steptime

CE1: Cycle1 Coulombic efficiency

CE2: Cycle2 Coulombic efficiency

CE3: Cycle3 Coulombic efficiency

CEVE: Cycle2 Cycle3 Coulombic efficiency average

Cha12mv2, Cha13mv2, Cha23mv2: Cycle2 Charge Voltage

Dis12mv2, Dis13mv2, Dis23mv2: Cycle2 Discharge Voltage

OP1_2mv2, OP1_3mv2, OP2_3mv2: Cycle2 over potentiol

Cha12mv3, Cha13mv3, Cha23mv3: Cycle3 Charge Voltage

Dis12mv3, Dis13mv3, Dis23mv3: Cycle3 Discharge Voltage

OP1_2mv3, OP1_3mv3, OP2_3mv3: Cycle3 over potentiol

DiFF12, DiFF13, DiFF23: Cycle voltage differrence

minMaxchdiff2, minMaxdisdiff2, minMaxchdiff3, minMaxdisdiff3: min and max for charge and discharge in Cycle2 and Cycle3

udp_Receive()

Receiving messages using UDP

This function DEPEND on robot.

Returns

True for success, False otherwise.

Return type

res (bool)

update_candidate_file(num_objectives, output_file, o_List)

Updating candidates

This function do not depend on robot.

Parameters

  • num_objectives (int) – the number of objectives

  • output_file (str) – the file for candidates

  • o_List (list[float]) – the list of objectives

Returns

True for success, False otherwise.

Return type

res (bool)