1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
|
# -*- coding: utf-8 -*-
"""OPEM functions."""
import datetime
from art import text2art
import opem.Script
from opem.Params import Version, Website, UpdateUrl, Warning_Message_1, Warning_Message_2
from opem.Params import HTML_Init_Template, HTML_Input_Table_Template1, HTML_Input_Table_Template2, HTML_Overall_Params_Table_Template, HTML_End_Template
import io
import os
import requests
import webbrowser
import sys
def integrate(y_vals, h):
"""
Calculate integral with Simpson's Rule.
:param y_vals: output values
:type y_vals: list
:param h: interval
:type h: float
:return: integrate output as float
"""
try:
i = 1
total = y_vals[0] + y_vals[-1]
for y in y_vals[1:-1]:
if i % 2 == 0:
total += 2 * y
else:
total += 4 * y
i += 1
return total * (h / 3.0)
except (TypeError, ZeroDivisionError):
return None
def linear_plot(x, y):
"""
Clear input data and call estimate_coef function.
:param x: x data
:type x: list
:param y: y data
:type y: list
:return: [estimated_y,intercept,slope] as list
"""
clear_x = []
clear_y = []
estimate_y = []
none_x = []
for index, item in enumerate(y):
if item is not None:
clear_y.append(item)
clear_x.append(x[index])
else:
none_x.append(x[index])
[B1, B0] = estimate_coef(clear_x, clear_y)
for i in x:
if i not in none_x:
estimate_y.append(B0 + B1 * i)
else:
estimate_y.append(None)
return [estimate_y, B0, B1]
def estimate_coef(clear_x, clear_y):
"""
Linear regression function.
:param clear_x: cleared x
:type clear_x: list
:param clear_y: cleared y
:type clear_y: list
:return: [slope,intercept]
"""
try:
n = len(clear_x)
mean_x = sum(clear_x) / n
mean_y = sum(clear_y) / n
SS_xy = 0
SS_xx = 0
for index, item in enumerate(clear_x):
SS_xx += item**2
SS_xy += item * clear_y[index]
SS_xx -= n * (mean_x)**2
SS_xy -= n * mean_x * mean_y
B1 = SS_xy / SS_xx
B0 = mean_y - B1 * mean_x
return [B1, B0]
except (TypeError, ZeroDivisionError, OverflowError, ValueError):
return [0, 0]
def line(num=11, char="#"):
"""
Print line of char.
:param num: number of characters
:type num: int
:param char: character
:type char: str
:return: None
"""
print(char * num)
def check_update(Version):
"""
Check for new OPEM version in website.
:param Version: current version of OPEM
:type Version: float
:return: None
"""
try:
update_obj = requests.get(UpdateUrl, timeout=100)
update_data = update_obj.text
if float(update_data) > Version:
line()
print("New Version (" + update_data + ") Is Available!")
print("Website : " + Website)
line()
except Exception:
print("Update Check Failed!")
def filter_default(input_dict, params_default):
"""
Filter input parameters with default params.
:param input_dict: input parameters
:type input_dict: dict
:param params_default: default parameters
:type params_default: dict
:return: modified input_dict as dict
"""
for i in params_default:
if i not in input_dict:
input_dict[i] = params_default[i]
return input_dict
def get_precision(input_number):
"""
Return precision of input number.
:param input_number: input number
:type input_number: float
:return: precision as int
"""
input_string = str(input_number)
if "." in input_string:
splitted_input = input_string.split(".")
return len(splitted_input[1])
return 0
def isfloat(value):
"""
Check input for float conversion.
:param value: input value
:type value: str
:return: True if input_value is a number and False otherwise
"""
try:
float(value)
return True
except ValueError:
return False
def rounder(input_number, digit=2):
"""
Round input number.
:param input_number: input number
:type input_number : anything
:param digit: precision
:type digit: int
:return: rounded number as float
"""
try:
if isfloat(input_number):
return round(input_number, digit)
return input_number
except Exception:
return None
def input_test(a):
"""
Injected function for Get_Input testing.
:param a: input
:type a: anything
:return: "1"
"""
_ = a
return "1"
def Get_Input(InputParams, input_item=input, params_default=None):
"""
Get inputs from users.
:param InputParams: input parameters for each model
:type InputParams: dict
:param input_item: input function (this parameter added for Get_Input doctest)
:type input_item: function
:param params_default: default parameters
:type params_default: dict
:return: input dictionary
"""
try:
Input_Keys = sorted(InputParams)
Input_Values = []
Name = ""
while(True):
Name = input_item("Please Enter Simulation Name :")
if len(Name) != 0:
break
else:
print("[Error] Bad Name Try Again")
for item in Input_Keys:
Input_Flag = False
Input_Item = None
while not Input_Flag:
Input_Item = input_item(
"Please Enter " + item + "(" + InputParams[item] + ") : ")
if isfloat(Input_Item):
Input_Flag = True
else:
if params_default is not None and item in params_default:
Input_Item = params_default[item]
Input_Flag = True
else:
print("[Error] Bad Input Try Again")
Input_Values.append(Input_Item)
Input_Values = list(map(float, Input_Values))
Output = dict(zip(Input_Keys, Input_Values))
Output["Name"] = Name
return Output
except Exception:
print("Bad Input")
return False
def Output_Save(
OutputParamsKeys,
OutputDict,
OutputParams,
i,
file,
PrintMode):
"""
Write analysis result in Simulation-Result.opem file.
:param OutputParamsKeys: output parameters keys
:type OutputParamsKeys: list
:param OutputDict: analysis result dictionary
:type OutputDict: dict
:param OutputParams: output parameters
:type OutputParams: dict
:param i: cell load current [A]
:type i: float
:param file: file
:type file: file object
:return: None
"""
spliter = "\n"
if 'win' not in sys.platform:
spliter = "\r\n"
file.write("I :" + str(i) + " A " + spliter * 2)
if PrintMode:
print("I : " + str(i))
for key in OutputParamsKeys:
file.write(key +
" : " +
str(OutputDict[key]) +
" " +
OutputParams[key] +
spliter)
if PrintMode:
print(key +
" : " +
str(OutputDict[key]) +
" " +
OutputParams[key])
file.write("###########" + spliter)
if PrintMode:
print("###########")
def Output_Init(InputDict, Title, Name, Folder):
"""
Initialize output file.
:param InputDict: input test vector
:type InputDict:dict
:param Title: simulation title
:type Title:str
:param Name: file name
:type Name: str
:param Folder: output folder address
:type Folder: str
:return: file object
"""
spliter = "\n"
if 'win' not in sys.platform:
spliter = "\r\n"
Art = text2art("Opem")
if not os.path.exists(Folder):
os.makedirs(Folder)
sim_folder = os.path.join(Folder, Title)
if not os.path.exists(sim_folder):
os.mkdir(sim_folder)
opem_file = open(os.path.join(sim_folder, Name + ".opem"), "w")
opem_file.write(Art)
opem_file.write("Simulation Date : " +
str(datetime.datetime.now()) + spliter)
opem_file.write("**********" + spliter)
opem_file.write(Title + " Model" + spliter * 2)
opem_file.write("**********" + spliter)
opem_file.write("Simulation Inputs : " + spliter * 2)
Input_Keys = sorted(InputDict)
for key in Input_Keys:
opem_file.write(key + " : " + str(InputDict[key]) + spliter)
opem_file.write("**********" + spliter)
return opem_file
def CSV_Init(OutputParamsKeys, OutputParams, Title, Name, Folder):
"""
Initialize CSV file.
:param OutputParamsKeys: output parameters Keys
:type OutputParamsKeys: list
:param OutputParams: output parameters
:type OutputParams: dict
:param Title: simulation title
:type Title:str
:param Name: file name
:type Name: str
:param Folder: output folder address
:type Folder: str
:return: file object
"""
if not os.path.exists(Folder):
os.makedirs(Folder)
sim_folder = os.path.join(Folder, Title)
if not os.path.exists(sim_folder):
os.mkdir(sim_folder)
csv_file = open(os.path.join(sim_folder, Name + ".csv"), "w")
csv_file.write("I (A),")
for index, item in enumerate(OutputParamsKeys):
csv_file.write(item + " (" + OutputParams[item] + ")")
if index < len(OutputParamsKeys) - 1:
csv_file.write(",")
csv_file.write("\n")
return csv_file
def None_Omit(Input_Str):
"""
Replace None object with "None" string.
:param Input_Str: input string
:type Input_Str: str
:return: modified string as str
"""
result = Input_Str
result = result.replace("None", '\"None\"')
return result
def HTML_Init(Title, Name, Folder):
"""
Initialize HTML file.
:param Title: simulation title (analysis model)
:type Title: str
:param Name: file name
:type Name: str
:param Folder: output folder address
:type Folder: str
:return: HTML file as file obj
"""
if not os.path.exists(Folder):
os.makedirs(Folder)
sim_folder = os.path.join(Folder, Title)
if not os.path.exists(sim_folder):
os.mkdir(sim_folder)
HTMLFile = io.open(
os.path.join(
sim_folder,
Name +
".html"),
"w",
encoding="utf-8")
HTMLFile.write(HTML_Init_Template.format(opem.Script.JS_SCRIPT, Title))
return HTMLFile
def HTML_Desc(Title, Description, file):
"""
Write model description in HTML file.
:param Title: simulation title (analysis model)
:type Title: str
:param Description: model description
:type Description: str
:param file: HTML file object
:type file: file object
:return: None
"""
file.write('<h2 style="color:#ff7600;">What is ' + Title + ' ?</h2>\n')
file.write(
'<p style = "text-align:justify;margin:15px;">' +
Description +
"</p>\n")
def HTML_Chart(x, y, color, x_label, y_label, chart_name, size, file):
"""
Write chartjs chart in HTML file.
:param x: x data as a string list
:type x: str
:param y: y data as string list (or list of y)
:param color: color code of chart (or list of color)
:type color: str
:param x_label:x-axis label
:type x_label : str
:param y_label:y-axis label
:type y_label : str
:param chart_name: chart name (or list of chart_name)
:type chart_name: str
:param size: chart size in pixel
:type size : str
:param file: HTML file object
:type file : file object
:return: None
"""
chart_data = ""
chart_title = str(chart_name)
if " " in chart_title:
chart_title = chart_title.replace(" ", "-")
if isinstance(y, list):
y_data = list(map(None_Omit, y))
for index, data in enumerate(y_data):
chart_data += opem.Script.CHART_DATA.format(
chart_name[index], data, color[index])
if index != len(y_data) - 1:
chart_data += ","
chart_data += "\n"
else:
y_data = None_Omit(y)
chart_data = opem.Script.CHART_DATA.format(chart_name, y_data, color)
x_data = None_Omit(x)
file.write(
opem.Script.LINE_CHART.format(
x_data,
y_label,
x_label,
chart_title,
size,
chart_data))
def HTML_Input_Table(Input_Dict, Input_Params, file):
"""
Add table to HTML file.
:param Input_Dict: input values dictionary
:type Input_Dict: dict
:param Input_Params: input parameters dictionary
:type Input_Params: dict
:param file: HTML file object
:type file: file object
:return: None
"""
file.write(HTML_Input_Table_Template1)
Input_Params_Keys = sorted(Input_Params)
for key in Input_Params_Keys:
file.write(
HTML_Input_Table_Template2.format(
key, Input_Params[key], str(
Input_Dict[key])))
file.write("</table>\n")
def HTML_Overall_Params_Table(
Input_Dict,
Input_Params,
file,
header=False):
"""
Add table to HTML file.
:param Input_Dict: input values dictionary
:type Input_Dict: dict
:param Input_Params: input parameters dictionary
:type Input_Params: dict
:param file: HTML file object
:type file: file object
:return: None
"""
if header:
file.write('<h2 style="color:#ff7600;">Overall Parameters</h2>\n')
file.write(HTML_Overall_Params_Table_Template)
Input_Params_Keys = sorted(Input_Params)
for key in Input_Params_Keys:
file.write(
HTML_Input_Table_Template2.format(
key, Input_Params[key], str(
Input_Dict[key])))
file.write("</table>\n")
if header:
file.write('<h2 style="color:#ff7600;">Graphs</h2>\n')
def HTML_End(file):
"""
Add end part of HTML file.
:param file: HTML file object
:type file: file object
:return: None
"""
file.write(HTML_End_Template.format(str(Version)))
file.write("</body>\n")
file.write("</html>")
def CSV_Save(OutputParamsKeys, OutputDict, i, file):
"""
Save parameters in CSV file.
:param OutputParamsKeys: output parameters keys
:type OutputParamsKeys: list
:param OutputDict: analysis result dictionary
:type OutputDict:dict
:param i: cell load current [A]
:type i: float
:param file: file
:type file: file object
:return: None
"""
file.write(str(i) + ",")
for key in OutputParamsKeys:
file.write(str(OutputDict[key]))
if key != OutputParamsKeys[-1]:
file.write(",")
file.write("\n")
def filter_lambda(Input_Dict):
"""
Filter lambda parameter.
:param Input_Dict: input parameters dictionary
:type Input_Dict: dict
:return: modified dictionary
"""
try:
if Input_Dict["lambda"] > 23:
Input_Dict["lambda"] = 23
print(
"[Warning] Opem Automatically Set Lambda To Maximum Value (23) ")
elif Input_Dict["lambda"] < 14:
Input_Dict["lambda"] = 23
print(
"[Warning] Opem Automatically Set Lambda To Minimum Value (14) ")
return Input_Dict
except Exception:
return Input_Dict
def left_justify(words, width):
"""
Left justify words.
:param words: list of words
:type words: list
:param width: width of each line
:type width: int
:return: left justified words as list
"""
return ' '.join(words).ljust(width)
def justify(words, width):
"""
Justify input words.
:param words: list of words
:type words: list
:param width: width of each line
:type width: int
:return: list of justified words as list
"""
line = []
col = 0
for word in words:
if line and col + len(word) > width:
if len(line) == 1:
yield left_justify(line, width)
else:
# After n + 1 spaces are placed between each pair of
# words, there are r spaces left over; these result in
# wider spaces at the left.
n, r = divmod(width - col + 1, len(line) - 1)
narrow = ' ' * (n + 1)
if r == 0:
yield narrow.join(line)
else:
wide = ' ' * (n + 2)
yield wide.join(line[:r] + [narrow.join(line[r:])])
line, col = [], 0
line.append(word)
col += len(word) + 1
if line:
yield left_justify(line, width)
def description_print(Analysis_Name, Description_Dict, Width=100):
"""
Print justified text for overview and each model description in console.
:param Analysis_Name: analysis model name
:type Analysis_Name: str
:param Description_Dict: description dict (in params)
:type Description_Dict: dict
:param Width: width of each line (for justify)
:type Width: int
:return: None
"""
line()
print(Analysis_Name.replace("_", " ") + " : \n")
if Analysis_Name.find("Padulles") != -1:
print("\n")
print(
"\n".join(
justify(
Description_Dict["General Padulles"].split(),
Width)))
print("\n")
print(
"\n".join(
justify(
Description_Dict[Analysis_Name].split(),
Width)))
print("\n")
line()
def description_control(
Analysis_Name,
Analysis_Dict,
User_Input,
Links_Dict,
Vectors_Dict):
"""
Control each analysis description.
:param Analysis_Name: analysis name
:type Analysis_Name: str
:param Analysis_Dict: analysis dict
:type Analysis_Dict: dict
:param User_Input: user input
:type User_Input: str
:param Links_Dict: documents links
:type Links_Dict: dict
:param Vectors_Dict: test vectors
:type Vectors_Dict: dict
:return: None
"""
if User_Input.upper() == "M":
webbrowser.open_new(Links_Dict[Analysis_Name])
elif User_Input.upper() == "T":
line()
print(Analysis_Name.replace("_", " ") + " Standard Test Vector\n")
Test_Vector = Vectors_Dict[Analysis_Name]
for i in Test_Vector:
print(i + " : " + str(Test_Vector[i]))
print("\n")
line()
_ = input("Press any key to continue")
Analysis_Dict[Analysis_Name](
InputMethod=Test_Vector, TestMode=True)
else:
Analysis_Dict[Analysis_Name]()
def filter_alpha(Input_Dict):
"""
Filter alpha parameter.
:param Input_Dict: input parameters dictionary
:type Input_Dict: dict
:return: modified dictionary
"""
try:
if Input_Dict["alpha"] > 1:
Input_Dict["alpha"] = 1
print("[Warning] Opem Automatically Set Alpha To Maximum Value (1) ")
elif Input_Dict["alpha"] < 0:
Input_Dict["alpha"] = 0
print("[Warning] Opem Automatically Set Alpha To Maximum Value (0) ")
return Input_Dict
except Exception:
return Input_Dict
def filter_range(IStart, IEnd, IStep):
"""
Filter current range.
:param IStart: current start point
:type IStart: float
:param IEnd: current end point
:type IEnd: float
:param IStep: current step
:type IStep: float
:return: filtered range as list
"""
temp = None
IStartO = IStart
IEndO = IEnd
IStepO = abs(IStep)
if IStartO > IEndO:
temp = IStartO
IStartO = IEndO
IEndO = temp
return [IStartO, IEndO, IStepO]
def warning_check_1(Vcell, I_Warning, I, warning_flag):
"""
Check Vcell is negative or not.
:param Vcell: Vcell of FC voltage
:type Vcell: float
:param I_Warning: first I of negative range
:type I_Warning: float
:param I: test current
:type I: float
:param warning_flag: input warning flag
:type warning_flag: bool
:return: update warning_flag and I_Warning [bool,float]
"""
if not warning_flag:
try:
if Vcell < 0:
return [True, I]
return [False, I]
except Exception:
return [False, I]
else:
return [True, I_Warning]
def warning_check_2(Vcell, warning_flag):
"""
Check Vcell is None or not.
:param Vcell: Vcell of FC Voltage
:type Vcell: float
:param warning_flag: input warning flag
:type warning_flag: bool
:return: update warning_flag as bool
"""
if not warning_flag:
if Vcell is None:
return True
return False
return True
def warning_print(
warning_flag_1,
warning_flag_2,
I_Warning,
file,
PrintMode):
"""
Print warning message and write messages to HTML report.
:param warning_flag_1: first warning message (Vcell <0)
:type warning_flag_1: bool
:param warning_flag_2: second warning message (Vcell==None)
:type warning_flag_2: bool
:param I_Warning: first I of negative range
:type I_Warning: float
:param file: HTML file object
:type file: file object
:param PrintMode: print mode control flag (True : print outputs)
:type PrintMode: bool
:return: None
"""
if warning_flag_1:
file.write(
'<p style="color:red;font-size:20px;text-align:center;">' +
Warning_Message_1 .format(
str(I_Warning)) +
'</p>\n')
if PrintMode:
print(Warning_Message_1.format(str(I_Warning)))
if warning_flag_2:
file.write(
'<p style="color:red;font-size:20px;text-align:center;">' +
Warning_Message_2 +
'</p>\n')
if PrintMode:
print(Warning_Message_2)
|