Separate installer and project

Author: Samuelopez-ansys

doc/source/Resources/PyAEDTInstallerFromDesktop.py

@@ -60,7 +60,7 @@ def run_pyinstaller_from_c_python(oDesktop):
         # enable in debu mode
         # f.write("import sys\n")
         # f.write('sys.path.insert(0, r"c:\\ansysdev\\git\\repos\\pyaedt")\n')
-        f.write("from pyaedt.workflows.project.pyaedt_installer import add_pyaedt_to_aedt\n")
+        f.write("from pyaedt.workflows.installer.pyaedt_installer import add_pyaedt_to_aedt\n")
         f.write(
             'add_pyaedt_to_aedt(aedt_version="{}", student_version={}, new_desktop_session=False)\n'.format(
                 oDesktop.GetVersion()[:6], is_student_version(oDesktop)))

pyaedt/workflows/customize_automation_tab.py

@@ -42,7 +42,13 @@
 
 
 def add_automation_tab(
-    name, lib_dir, icon_file=None, product="Project", template="Run PyAEDT Toolkit Script", overwrite=False
+    name,
+    lib_dir,
+    icon_file=None,
+    product="Project",
+    template="Run PyAEDT Toolkit Script",
+    overwrite=False,
+    panel="Panel_PyAEDT_Toolkits",
 ):
     """Add an automation tab in AEDT.
 
@@ -61,6 +67,8 @@ def add_automation_tab(
     overwrite : bool, optional
         Whether to overwrite the existing automation tab. The default is ``False``, in
         which case is adding new tabs to the existing ones.
+    panel : str, optional
+        Panel name. The default is ``"Panel_PyAEDT_Toolkits"``.
 
     Returns
     -------
@@ -82,22 +90,22 @@ def add_automation_tab(
 
     panels = root.findall("./panel")
     if panels:
-        panel_names = [panel.attrib["label"] for panel in panels]
-        if "Panel_PyAEDT_Toolkits" in panel_names:
+        panel_names = [panel_element.attrib["label"] for panel_element in panels]
+        if panel in panel_names:
             # Remove previously existing PyAEDT panel and update with newer one.
-            panel = [panel for panel in panels if panel.attrib["label"] == "Panel_PyAEDT_Toolkits"][0]
+            panel_element = [panel_element for panel_element in panels if panel_element.attrib["label"] == panel][0]
         else:
-            panel = ET.SubElement(root, "panel", label="Panel_PyAEDT_Toolkits")
+            panel_element = ET.SubElement(root, "panel", label=panel)
     else:
-        panel = ET.SubElement(root, "panel", label="Panel_PyAEDT_Toolkits")
+        panel_element = ET.SubElement(root, "panel", label=panel)
 
-    buttons = panel.findall("./button")
+    buttons = panel_element.findall("./button")
     if buttons:
         button_names = [button.attrib["label"] for button in buttons]
         if name in button_names:
             # Remove previously existing PyAEDT panel and update with newer one.
             b = [button for button in buttons if button.attrib["label"] == name][0]
-            panel.remove(b)
+            panel_element.remove(b)
 
     if not icon_file:
         icon_file = os.path.join(os.path.dirname(pyaedt.workflows.__file__), "images", "large", "pyansys.png")
@@ -111,7 +119,7 @@ def add_automation_tab(
     shutil.copy(icon_file, dest_file)
 
     ET.SubElement(
-        panel,
+        panel_element,
         "button",
         label=name,
         isLarge="1",
@@ -127,7 +135,7 @@ def add_automation_tab(
     return tab_config_file_path
 
 
-def remove_automation_tab(name, lib_dir):
+def remove_automation_tab(name, lib_dir, panel="Panel_PyAEDT_Toolkits"):
     """Remove automation tab in AEDT.
 
     Parameters
@@ -136,6 +144,8 @@ def remove_automation_tab(name, lib_dir):
         Toolkit name.
     lib_dir : str
         Path to the library directory.
+    panel : str, optional
+        Panel name. The default is ``"Panel_PyAEDT_Toolkits"``.
 
     Returns
     -------
@@ -156,22 +166,22 @@ def remove_automation_tab(name, lib_dir):
 
     panels = root.findall("./panel")
     if panels:
-        panel_names = [panel.attrib["label"] for panel in panels]
-        if "Panel_PyAEDT_Toolkits" in panel_names:
+        panel_names = [panel_element.attrib["label"] for panel_element in panels]
+        if panel in panel_names:
             # Remove previously existing PyAEDT panel and update with newer one.
-            panel = [panel for panel in panels if panel.attrib["label"] == "Panel_PyAEDT_Toolkits"][0]
+            panel_element = [panel_element for panel_element in panels if panel.attrib["label"] == panel][0]
         else:
-            panel = ET.SubElement(root, "panel", label="Panel_PyAEDT_Toolkits")
+            panel_element = ET.SubElement(root, "panel", label=panel)
     else:
-        panel = ET.SubElement(root, "panel", label="Panel_PyAEDT_Toolkits")
+        panel_element = ET.SubElement(root, "panel", label=panel)
 
-    buttons = panel.findall("./button")
+    buttons = panel_element.findall("./button")
     if buttons:
         button_names = [button.attrib["label"] for button in buttons]
         if name in button_names:
             # Remove previously existing PyAEDT panel and update with newer one.
             b = [button for button in buttons if button.attrib["label"] == name][0]
-            panel.remove(b)
+            panel_element.remove(b)
 
     create_xml_tab(root, tab_config_file_path)
 
@@ -193,7 +203,7 @@ def create_xml_tab(root, output_file):
         f.write(xml_str)
 
 
-def remove_xml_tab(toolkit_dir, name):
+def remove_xml_tab(toolkit_dir, name, panel="Panel_PyAEDT_Toolkits"):
     """Remove a toolkit configuration file."""
     tab_config_file_path = os.path.join(toolkit_dir, "TabConfig.xml")
     if not os.path.isfile(tab_config_file_path):
@@ -207,22 +217,22 @@ def remove_xml_tab(toolkit_dir, name):
 
     panels = root.findall("./panel")
     if panels:
-        panel_names = [panel.attrib["label"] for panel in panels]
-        if "Panel_PyAEDT_Toolkits" in panel_names:
+        panel_names = [panel_element.attrib["label"] for panel_element in panels]
+        if panel in panel_names:
             # Remove previously existing PyAEDT panel and update with newer one.
-            panel = [panel for panel in panels if panel.attrib["label"] == "Panel_PyAEDT_Toolkits"][0]
+            panel_element = [panel_element for panel_element in panels if panel_element.attrib["label"] == panel][0]
         else:
-            panel = ET.SubElement(root, "panel", label="Panel_PyAEDT_Toolkits")
+            panel_element = ET.SubElement(root, "panel", label=panel)
     else:
-        panel = ET.SubElement(root, "panel", label="Panel_PyAEDT_Toolkits")
+        panel_element = ET.SubElement(root, "panel", label=panel)
 
-    buttons = panel.findall("./button")
+    buttons = panel_element.findall("./button")
     if buttons:
         button_names = [button.attrib["label"] for button in buttons]
         if name in button_names:
             # Remove previously existing PyAEDT panel and update with newer one.
             b = [button for button in buttons if button.attrib["label"] == name][0]
-            panel.remove(b)
+            panel_element.remove(b)
 
     create_xml_tab(root, tab_config_file_path)
 
@@ -261,6 +271,7 @@ def add_script_to_menu(
     product="Project",
     copy_to_personal_lib=True,
     executable_interpreter=None,
+    panel="Panel_PyAEDT_Toolkits",
 ):
     """Add a script to the ribbon menu.
 
@@ -289,6 +300,8 @@ def add_script_to_menu(
         Whether to copy the script to Personal Lib or link the original script. Default is ``True``.
     executable_interpreter : str, optional
         Executable python path. The default is the one current interpreter.
+    panel : str, optional
+        Panel name. The default is ``"Panel_PyAEDT_Toolkits"``.
 
     Returns
     -------
@@ -347,7 +360,9 @@ def add_script_to_menu(
             out_file.write(build_file_data)
 
     if aedt_version >= "2023.2":
-        add_automation_tab(name, toolkit_dir, icon_file=icon_file, product=product, template=file_name_dest)
+        add_automation_tab(
+            name, toolkit_dir, icon_file=icon_file, product=product, template=file_name_dest, panel=panel
+        )
     desktop_object.logger.info("{} installed".format(name))
     return True
 

pyaedt/workflows/installer/__init__.py

@@ -0,0 +1,21 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.

pyaedt/workflows/project/console_setup.py renamed to pyaedt/workflows/installer/console_setup.py

@@ -120,4 +120,5 @@ def __add_pyaedt_tabs(desktop_object):
                 product="Project",
                 copy_to_personal_lib=True,
                 executable_interpreter=None,
+                panel="Panel_PyAEDT_Installer",
             )

pyaedt/workflows/project/create_report.py renamed to pyaedt/workflows/installer/create_report.py

@@ -33,7 +33,7 @@
 from pyaedt.workflows.customize_automation_tab import add_script_to_menu
 from pyaedt.workflows.customize_automation_tab import available_toolkits
 from pyaedt.workflows.customize_automation_tab import remove_script_from_menu
-import pyaedt.workflows.project
+import pyaedt.workflows.installer
 
 env_vars = ["PYAEDT_SCRIPT_VERSION", "PYAEDT_SCRIPT_PORT", "PYAEDT_STUDENT_VERSION"]
 if all(var in os.environ for var in env_vars):
@@ -60,9 +60,6 @@
 def create_toolkit_page(frame, window_name, internal_toolkits):
     """Create page to display toolkit on."""
     # Available toolkits
-    if window_name == "Project":
-        # Remove PyAEDT installer toolkits from the list
-        internal_toolkits = internal_toolkits[:-4]
     toolkits = ["Custom"] + internal_toolkits
 
     max_length = max(len(item) for item in toolkits) + 1
@@ -270,7 +267,7 @@ def button_is_clicked(
 root.title("AEDT Toolkit Manager")
 
 # Load the logo for the main window
-icon_path = os.path.join(os.path.dirname(pyaedt.workflows.project.__file__), "images", "large", "logo.png")
+icon_path = os.path.join(os.path.dirname(pyaedt.workflows.installer.__file__), "images", "large", "logo.png")
 im = PIL.Image.open(icon_path)
 photo = PIL.ImageTk.PhotoImage(im)
 

pyaedt/workflows/project/images/large/console.png renamed to pyaedt/workflows/installer/images/large/console.png

@@ -0,0 +1,23 @@
+[Console]
+name = "PyAEDT Console"
+script = "console_setup.py"
+icon = "console.png"
+template = "PyAEDT_Console"
+
+[Jupyter]
+name = "Jupyter Notebook"
+script = "jupyter_template.ipynb"
+icon = "jupyter.png"
+template = "Jupyter"
+
+[Run_Script]
+name = "Run PyAEDT Script"
+script = ""
+icon = "run_script.png"
+template = "Run_PyAEDT_Script"
+
+[ToolkitManager]
+name = "Toolkit Manager"
+script = "toolkit_manager.py"
+icon = "toolkit_manager.png"
+template = "Run_Toolkit_Manager"

pyaedt/workflows/project/images/large/jupyter.png renamed to pyaedt/workflows/installer/images/large/jupyter.png

@@ -1,23 +0,0 @@
-[Console]
-name = "PyAEDT Console"
-script = "console_setup.py"
-icon = "console.png"
-template = "PyAEDT_Console"
-
-[Jupyter]
-name = "Jupyter Notebook"
-script = "jupyter_template.ipynb"
-icon = "jupyter.png"
-template = "Jupyter"
-
-[Run_Script]
-name = "Run PyAEDT Script"
-script = ""
-icon = "run_script.png"
-template = "Run_PyAEDT_Script"
-
-[ToolkitManager]
-name = "Toolkit Manager"
-script = "toolkit_manager.py"
-icon = "toolkit_manager.png"
-template = "Run_Toolkit_Manager"