mg-pso-gui 0.2.93__py3-none-any.whl → 0.2.95__py3-none-any.whl

{mg_pso_gui-0.2.93.dist-info → mg_pso_gui-0.2.95.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mg-pso-gui
-Version: 0.2.93
+Version: 0.2.95
 Summary: GUI for MG-PSO
 Author: Robert Cordingly
 Author-email: <rcording@uw.ed>

{mg_pso_gui-0.2.93.dist-info → mg_pso_gui-0.2.95.dist-info}/RECORD

@@ -1,7 +1,7 @@
 mgpsogui/__init__.py,sha256=q7AfBjeJABnFtbsZnsObpUwaXKPDVYtz46G6MKXLF74,42
 mgpsogui/mgpsogui.py,sha256=NIZmyNcbwC8EgSwf1ubdMUSJscrIEgoD4jLYziqHQ-k,148
 mgpsogui/start.yaml,sha256=ZjCVLb-MLqAxrGRm9kA7_SDpa-45EuKIELNQ2QqCAiU,4713
-mgpsogui/gui/HomePage.py,sha256=zGYiJJIPZfSOfVolPtPW3t5ZK_4axqu-M9VfRHo-tuo,22993
+mgpsogui/gui/HomePage.py,sha256=_6CWBFHRJrePbJ0iCty4ohPjdZ6SQ7Fl7Gus8FuHpIc,23233
 mgpsogui/gui/OptionManager.py,sha256=OczLGSmS9MfE2HgpPNw0OFbl2AdNQ_70pxQUKIDWAnU,21707
 mgpsogui/gui/OptionManager_backup.py,sha256=TCWfPnHL2foN5id47jsi267lamRG6yGU6y_M29eOOJk,18530
 mgpsogui/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -46,7 +46,7 @@ mgpsogui/gui/images/stop.png,sha256=JPuxXQerCGpLikcp7cAj3iLCOjULMYYZ2sZe0lArh68,
 mgpsogui/gui/images/test.png,sha256=MUnVpRK-isxhEHzx4Q6Yh0M6FRZD1qvgCHH2XmiSBbk,3642
 mgpsogui/gui/images/trash.png,sha256=j8cf0kWbJd-4Jp20lUVV1o1NSeQ4v1Ej4gfcIA3DVRQ,2958
 mgpsogui/gui/images/up.png,sha256=AQvFWCUqSQNaQ1E6LKZ9zNfSvW6t4mgy8uswdg9T2Hg,2457
-mgpsogui/gui/messages/welcome.txt,sha256=fZABECaJz8jJEzogCbNnWGUgEdOvd_6FwONUBAa0LuM,3772
+mgpsogui/gui/messages/welcome.txt,sha256=KzN_Zk3vaZeXx-G2KJmd5I7Q1_Shw62E9Fx8U4rQuUQ,5674
 mgpsogui/util/GraphGenerator.py,sha256=LHHDCvBuJQ0RYQm0azi5tC-etrZ1KLQh-tkahVurPSI,31990
 mgpsogui/util/PSORunner.py,sha256=tTe2sF9MRk48dpsNwSn_CbSSNq1laXWMxSZFh_v5FIQ,23115
 mgpsogui/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -73,8 +73,8 @@ mgpsogui/util/recosu/utils/trace_writer.py,sha256=V9BJlOjCbNYGoXGEk3CF5wjifBxvar
 mgpsogui/util/recosu/utils/utils.py,sha256=QB8vftq3142ekG0ORjz0ZBHU5YknXbR0oTsrxrPAsF0,3951
 mgpsogui/util/recosu/utils/plot/__init__.py,sha256=h1KjM7_tNDv351pcwt8A6Ibb1jhwWyx5Gbu-zj-sI3Q,71
 mgpsogui/util/recosu/utils/plot/cost_steps.py,sha256=1Ce11AJyweWkmvjXPxEygzS-h8yVLmQEDLS53yjPLqQ,3779
-mg_pso_gui-0.2.93.dist-info/METADATA,sha256=QUDkQ8rtTYHKkTGEmMEDjHO4iG_PVVYsUTADkVLL59g,9455
-mg_pso_gui-0.2.93.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-mg_pso_gui-0.2.93.dist-info/entry_points.txt,sha256=jg82VOFjR1XDGrchs1wJSCqKYE4Ozv12aBcCSp--koA,117
-mg_pso_gui-0.2.93.dist-info/top_level.txt,sha256=y7JuS9xJN5YdxUsQ3PSVjN8MzQAnR146bP3ZN3PYWdE,9
-mg_pso_gui-0.2.93.dist-info/RECORD,,
+mg_pso_gui-0.2.95.dist-info/METADATA,sha256=woXYXAi8uBQQH_gTxbSxRTt9fdwpy99opYy8a4VR-L4,9455
+mg_pso_gui-0.2.95.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+mg_pso_gui-0.2.95.dist-info/entry_points.txt,sha256=jg82VOFjR1XDGrchs1wJSCqKYE4Ozv12aBcCSp--koA,117
+mg_pso_gui-0.2.95.dist-info/top_level.txt,sha256=y7JuS9xJN5YdxUsQ3PSVjN8MzQAnR146bP3ZN3PYWdE,9
+mg_pso_gui-0.2.95.dist-info/RECORD,,

mgpsogui/gui/HomePage.py

@@ -153,7 +153,10 @@ class App(customtkinter.CTk):
 																command=self.change_scaling_event)
 		self.scaling_optionemenu.grid(row=0, column=8, padx=(5, 20), pady=header_padding_y)
 		self.scaling_optionemenu.set("100%")
-		
+
+		self.help_button = customtkinter.CTkButton(self.sidebar_frame, text="Help", width=20, command=self.open_help)
+		self.help_button.grid(row=0, column=9, padx=header_padding_x, pady=header_padding_y)
+
 		expand_image = customtkinter.CTkImage(Image.open(os.path.join("./images", "expand.png")), size=(20, 20))
 		#self.new_window = customtkinter.CTkButton(self.sidebar_frame, text=None, width=30, image=expand_image, command=self.open_new_window)
 		#ctt(self.new_window, delay=0.1, alpha=0.95, message="Open New Window")
@@ -211,7 +214,10 @@ class App(customtkinter.CTk):
 		self.after(1000, self.running_loop)
 
 		# Read the file ./messages/welcome.txt and load it as a string and put it into the message
+
+		self.open_help()
 		
+	def open_help(self):
 		with open(os.path.join("./messages", "welcome.txt"), "r") as f:
 			message = f.read()
 			NW(title="Welcome!", message=message)

mgpsogui/gui/messages/welcome.txt

@@ -16,10 +16,28 @@ The final editor is the Minikube Environment Editor. This tool is used to deploy
 
 The Setup Tab is the most advanced tab and will be used to define all of the parameters used in each of the workflow modes. In all modes, the right sidebar can be used to define Model Parameters and Hyperparameters. The values here depend on the mode, but both of these editors allow for various parameters to be defined. These editors support a variety of data types including strings, floats, integers, dates, and booleans. The editor will adapt the UI and show the appropriate editor depending on the data type (e.g. dates will have a date picker, booleans a True/False dropdown, or a textbox for strings).
 
-The second editor is the Group Editor. In Optimization you will be able to define multiple groups while all other modes only support a single group. The Group Editor includes options to create new groups, delete them, rearrange their order, expand/contract them, and overwrite global parameters defined in the sidebar. In each group you can define Bounds and Objective Functions. Each group has a variety of bounds and objective functions and all of their details can be defined here. Bounds can be imported from CSV files or edited in the interface. The Bounds editor will provide information about each parameter from the service in tooltips and notify when a parameter is outside the recommended bound by highlighting them in Red. 
+The second editor is the Group Editor. In Optimization you will be able to define multiple groups while all other modes only support a single group. The Group Editor includes options to create new groups, delete them, rearrange their order, expand/contract them, and overwrite global parameters defined in the sidebar. In each group you can define Bounds and Objective Functions. Each group has a variety of bounds and objective functions and all of their details can be defined here. Bounds can be imported from CSV files or edited in the interface. The Bounds editor will provide information about each parameter from the service in tooltips and notify when a parameter is outside the recommended bound by highlighting them in Red. In other modes besides Optimization the Setup Tab show less information, only the attributes relevant to each mode.
 
 --- Results Tab ---
 
+The Results Tab is where data can be visualized after a workflow step is ran, or view progress while Optimization is running. The main interface of the Results Tab is the left sidebar, where the figure type can be selected and then any relevant fields are displayed to edit the figure. Each mode has different figure types:
+
+Optimization:
+- Best Cost Stacked
+- Best Cost by Round
+- Custom CSV
+- Compare CSV
+
+Sensitivity Analysis: 
+- Custom CSV
+- Compare CSV
+
+Sampling:
+- Sampling CSV
+- Matrix Editor
+
+Each of the CSV editors are the most powerful figure editors, each with extensive options to customize how the figure is generated and which dataset is being used. Figures can be generated with different themes and then Exported in a variety of formats including HTML, Plotly JSON, PDF, and PNG. If you need to more closely view a figure you can click the "Preview" option to open the graph in a web browser. While the a browser each figure has an interactive interface where the figure can be zoomed, cropped, analyzed, and exported into different formats.
 
 --- Project Tab ---
 
+The final tab is the Project Tab. This tab is likely used the least compared to all of the others. Here you can view the console output of the interface, this can be used to observe errors that are happening. In addition to that this tab also has the Project Editor. This is where you can copy data between modes. So as the workflow is built out it is expected to start with Sampling, do Sensitivity Analysis, and end with Optimization. Instead of having to setup each mode individually the parameters from one can be transferred between modes using this tab. Alongside that the Project Folder and various other project attributes can be viewed here. Finally, the Optimal Parameters found using Optimization can be viewed here.