FIX: Create virtual environment per Python version (#4681)

Co-authored-by: Maxime Rey <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>

Author: 3 people

_unittest/test_01_toolkit_icons.py

@@ -110,5 +110,5 @@ def validate_file_exists_and_pyaedt_tabs_added(file_path):
         root = tree.getroot()
         panels = root.findall("./panel")
         panel_names = [panel.attrib["label"] for panel in panels]
-        assert "Panel_PyAEDT_Toolkits" in panel_names
+        assert "Panel_PyAEDT_Extensions" in panel_names
         return root

doc/source/Getting_started/Installation.rst

@@ -19,7 +19,7 @@ using the CPython interpreter included in the AEDT installation.
 
 In order to do that you can:
 
-- Download the following file: :download:`PyAEDT Installer Python file <../Resources/PyAEDTInstallerFromDesktop.py>`
+- Download the following file: :download:`PyAEDT Installer Python file <../Resources/pyaedt_installer_from_aedt.py>`
 
 - Open an Electronics Desktop Session and click on Tools->Run Script and execute the file.
 
@@ -44,16 +44,16 @@ Starting from 2023R2, buttons are available in the Automation Tab as in the exam
   :alt: PyAEDT toolkit buttons available in AEDT
 
 
-Toolkit Manager
-~~~~~~~~~~~~~~~
-The user can install or uninstall automated workflows using the toolkit manager.
+Extension manager
+~~~~~~~~~~~~~~~~~
+The user can install or uninstall automated workflows using the extension manager.
 There are three options:
 
 - Custom PyAEDT scripts.
 
-- Internal PyAEDT scripts. Existing workflows in the PyAEDT library.
+- Existing workflows in the PyAEDT library.
 
-- Open source PyAEDT toolkits. Open source PyAEDT toolkits following the `common library <https://aedt.common.toolkit.docs.pyansys.com/>`_ standard.
+- Open source PyAEDT toolkits described in the `PyAEDT Common Toolkit documentation <https://aedt.common.toolkit.docs.pyansys.com/>`_.
 
 .. image:: ../Resources/toolkit_manager_1.png
   :width: 800

doc/source/Getting_started/Troubleshooting.rst

@@ -50,7 +50,7 @@ run the Python command:
 
 
 Another option to install PyAEDT from the wheelhouse is to download the following file
-:download:`PyAEDT Installer Python file <../Resources/PyAEDTInstallerFromDesktop.py>`.
+:download:`PyAEDT Installer Python file <../Resources/pyaedt_installer_from_aedt.py>`.
 Run this script directly from AEDT and pass the wheelhouse file name as an argument.
 
 

doc/source/Resources/PyAEDTInstallerFromDesktop.py renamed to doc/source/Resources/pyaedt_installer_from_aedt.py

@@ -8,20 +8,28 @@
 is_linux = os.name == "posix"
 is_windows = not is_linux
 
+VENV_DIR_PREFIX = ".pyaedt_env"
+
 
 def run_pyinstaller_from_c_python(oDesktop):
-    # This is called when run from IronPython
+    # Iron Python script to create the virtual environment and install PyAEDT
+    # Get AEDT information
     version = oDesktop.GetVersion()[2:6].replace(".", "")
-    python_version = "3.10"
-    if version <= "231":
-        python_version = "3.7"
+    # From AEDT 2023.2 the installed CPython version is 3.10
+    python_version = "3.10" if version > "231" else "3.7"
+    python_version_new = python_version.replace(".", "_")
+    # AEDT installation root
     edt_root = os.path.normpath(oDesktop.GetExeDir())
+    # CPython interpreter executable
     if is_windows:
-        python_exe = os.path.normpath(os.path.join(edt_root, "commonfiles", "CPython", python_version.replace(".", "_"),
+        python_exe = os.path.normpath(os.path.join(edt_root, "commonfiles", "CPython", python_version_new,
                                                    "winx64", "Release", "python", "python.exe"))
     else:
-        python_exe = os.path.normpath(os.path.join(edt_root, "commonfiles", "CPython", python_version.replace(".", "_"),
+        python_exe = os.path.normpath(os.path.join(edt_root, "commonfiles", "CPython", python_version_new,
                                                    "linx64", "Release", "python", "runpython"))
+
+    # Launch this script again from the CPython interpreter. This calls the ``install_pyaedt()`` method,
+    # which creates a virtual environment and installs PyAEDT and its dependencies
     command = ['"{}"'.format(python_exe), '"{}"'.format(os.path.normpath(__file__)), "--version=" + version]
     if is_student_version(oDesktop):
         command.append("--student")
@@ -42,17 +50,21 @@ def run_pyinstaller_from_c_python(oDesktop):
         return_code = run_command(" ".join(command))
         err_msg = "There was an error while installing PyAEDT. Refer to the Terminal window where AEDT was launched " \
                   "from."
-    if is_windows:
-        venv_dir = os.path.join(os.environ["APPDATA"], "pyaedt_env_ide", "v" + version)
-        python_exe = os.path.join(venv_dir, "Scripts", "python.exe")
-    else:
-        venv_dir = os.path.join(os.environ["HOME"], "pyaedt_env_ide", "v" + version)
-        python_exe = os.path.join(venv_dir, "bin", "python")
+
     if str(return_code) != "0":
         oDesktop.AddMessage("", "", 2, err_msg)
         return
     else:
         oDesktop.AddMessage("", "", 0, "PyAEDT virtual environment created.")
+
+    # Add PyAEDT tabs in AEDT
+    # Virtual environment path and Python executable
+    if is_windows:
+        venv_dir = os.path.join(os.environ["APPDATA"], VENV_DIR_PREFIX, python_version_new)
+        python_exe = os.path.join(venv_dir, "Scripts", "python.exe")
+    else:
+        venv_dir = os.path.join(os.environ["HOME"], VENV_DIR_PREFIX, python_version_new)
+        python_exe = os.path.join(venv_dir, "bin", "python")
     pyaedt_path = os.path.join(venv_dir, "Lib", "site-packages", "pyaedt")
     if is_linux:
         for dirpath, dirnames, _ in os.walk(venv_dir):
@@ -62,35 +74,51 @@ def run_pyinstaller_from_c_python(oDesktop):
                 )
                 if os.path.isdir(pyaedt_path):
                     break
+
+    # Create PyAEDT symbolic link in PersonalLib
     personal_lib_dir = oDesktop.GetPersonalLibDirectory()
     pers1 = os.path.join(personal_lib_dir, "pyaedt")
+
     if os.path.exists(pers1):
-        oDesktop.AddMessage("", "", 2, "PersonalLib already mapped.")
-    else:
         if is_windows:
-            command = 'mklink /D "{}" "{}"'.format(pers1, pyaedt_path)
+            command = 'rmdir "{}"'.format(pers1)
         else:
-            command = 'ln -s "{}" "{}"'.format(pyaedt_path, pers1)
+            command = 'rm "{}"'.format(pers1)
         ret_code = os.system(command)
         if ret_code != 0:
-            oDesktop.AddMessage("", "", 2, "Error configuring symbolic link to pyaedt in PersonalLib.")
+            oDesktop.AddMessage("", "", 2,
+                                "Error occurred while removing the symbolic link to PyAEDT in 'PersonalLib'.")
+
+    if is_windows:
+        command = 'mklink /D "{}" "{}"'.format(pers1, pyaedt_path)
+    else:
+        command = 'ln -s "{}" "{}"'.format(pyaedt_path, pers1)
+    ret_code = os.system(command)
+    if ret_code != 0:
+        oDesktop.AddMessage("", "", 2, "Error occurred while configuring the symbolic link to PyAEDT in 'PersonalLib'.")
+
+    # Create Toolkits in PersonalLib
     import tempfile
     python_script = os.path.join(tempfile.gettempdir(), "configure_pyaedt.py")
+    if os.path.isfile(python_script):
+        os.remove(python_script)
     with open(python_script, "w") as f:
         # 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.installer.pyaedt_installer import add_pyaedt_to_aedt\n")
         f.write(
-            'add_pyaedt_to_aedt(aedt_version="{}", personallib=r"{}")\n'.format(
+            'add_pyaedt_to_aedt(aedt_version="{}", personal_lib=r"{}")\n'.format(
                 oDesktop.GetVersion()[:6], oDesktop.GetPersonalLibDirectory()))
 
     command = r'"{}" "{}"'.format(python_exe, python_script)
-    oDesktop.AddMessage("", "", 0, "Configuring PyAEDT Tabs.")
+    oDesktop.AddMessage("", "", 0, "Configuring PyAEDT panels in automation tab.")
     ret_code = os.system(command)
     if ret_code != 0:
-        oDesktop.AddMessage("", "", 2, "Error configuring the configuration Tab.")
+        oDesktop.AddMessage("", "", 2, "Error occurred configuring the PyAEDT panels.")
         return
+    # Refresh UI
+    oDesktop.CloseAllWindows()
     if version >= "232":
         oDesktop.RefreshToolkitUI()
     msg = "PyAEDT configuration complete."
@@ -102,6 +130,7 @@ def run_pyinstaller_from_c_python(oDesktop):
         from System.Windows.Forms import MessageBox, MessageBoxButtons, MessageBoxIcon
         oDesktop.AddMessage("", "", 0, msg)
         MessageBox.Show(msg, 'Info', MessageBoxButtons.OK, MessageBoxIcon.Information)
+    oDesktop.AddMessage("", "", 0, "Create a project if the PyAEDT panel is not visible.")
 
 
 def parse_arguments_for_pyaedt_installer(args=None):
@@ -123,12 +152,17 @@ def parse_arguments_for_pyaedt_installer(args=None):
 def install_pyaedt():
     # This is called when run from CPython
     args = parse_arguments_for_pyaedt_installer()
+
+    python_version = "3_10"
+    if args.version <= "231":
+        python_version = "3_7"
+
     if is_windows:
-        venv_dir = os.path.join(os.environ["APPDATA"], "pyaedt_env_ide", "v" + args.version)
+        venv_dir = os.path.join(os.environ["APPDATA"], VENV_DIR_PREFIX, python_version)
         python_exe = os.path.join(venv_dir, "Scripts", "python.exe")
         pip_exe = os.path.join(venv_dir, "Scripts", "pip.exe")
     else:
-        venv_dir = os.path.join(os.environ["HOME"], "pyaedt_env_ide", "v" + args.version)
+        venv_dir = os.path.join(os.environ["HOME"], VENV_DIR_PREFIX, python_version)
         python_exe = os.path.join(venv_dir, "bin", "python")
         pip_exe = os.path.join(venv_dir, "bin", "pip")
         os.environ["ANSYSEM_ROOT{}".format(args.version)] = args.edt_root
@@ -158,14 +192,14 @@ def install_pyaedt():
             run_command('"{}" -m venv "{}"'.format(sys.executable, venv_dir))
 
         if args.wheel and os.path.exists(args.wheel):
-            wheelpyaedt = args.wheel
+            wheel_pyaedt = args.wheel
             import zipfile
-            unzipped_path = os.path.join(os.path.dirname(wheelpyaedt),
-                                         os.path.splitext(os.path.basename(wheelpyaedt))[0])
+            unzipped_path = os.path.join(os.path.dirname(wheel_pyaedt),
+                                         os.path.splitext(os.path.basename(wheel_pyaedt))[0])
             if os.path.exists(unzipped_path):
                 shutil.rmtree(unzipped_path, ignore_errors=True)
-            with zipfile.ZipFile(wheelpyaedt, 'r') as zip_ref:
-                # Extract all contents to a directory (you can specify a different extraction path if needed)
+            with zipfile.ZipFile(wheel_pyaedt, 'r') as zip_ref:
+                # Extract all contents to a directory. (You can specify a different extraction path if needed.)
                 zip_ref.extractall(unzipped_path)
 
             run_command(
@@ -178,7 +212,7 @@ def install_pyaedt():
             run_command('"{}" -m pip install --upgrade pip'.format(python_exe))
             run_command('"{}" --default-timeout=1000 install wheel'.format(pip_exe))
             # run_command(
-            # '"{}" --default-timeout=1000 install git+https://github.com/ansys/pyaedt.git@fix/main'.format(pip_exe))
+            # '"{}" --default-timeout=1000 install git+https://github.com/ansys/pyaedt.git@main'.format(pip_exe))
             run_command('"{}" --default-timeout=1000 install pyaedt[all]'.format(pip_exe))
             run_command('"{}" --default-timeout=1000 install jupyterlab'.format(pip_exe))
             run_command('"{}" --default-timeout=1000 install ipython -U'.format(pip_exe))
@@ -191,14 +225,14 @@ def install_pyaedt():
         run_command('"{}" uninstall --yes pyaedt'.format(pip_exe))
 
         if args.wheel and os.path.exists(args.wheel):
-            wheelpyaedt = args.wheel
+            wheel_pyaedt = args.wheel
             import zipfile
-            unzipped_path = os.path.join(os.path.dirname(wheelpyaedt),
-                                         os.path.splitext(os.path.basename(wheelpyaedt))[0])
+            unzipped_path = os.path.join(os.path.dirname(wheel_pyaedt),
+                                         os.path.splitext(os.path.basename(wheel_pyaedt))[0])
             if os.path.exists(unzipped_path):
                 shutil.rmtree(unzipped_path, ignore_errors=True)
-            with zipfile.ZipFile(wheelpyaedt, 'r') as zip_ref:
-                # Extract all contents to a directory (you can specify a different extraction path if needed)
+            with zipfile.ZipFile(wheel_pyaedt, 'r') as zip_ref:
+                # Extract all contents to a directory. (You can specify a different extraction path if needed.)
                 zip_ref.extractall(unzipped_path)
 
             run_command('"{}" install --no-cache-dir --no-index --find-links={} pyaedt'.format(pip_exe, unzipped_path))
@@ -224,9 +258,8 @@ def run_command(command):
 
 if __name__ == "__main__":
 
-    # When launched from Toolkit (i.e. IronPython) call this same file using CPython
     if is_iron_python:
-        # Check if wheelhouse defined, wheelhouse is created for Windows only
+        # Check if wheelhouse defined. Wheelhouse is created for Windows only.
         wheelpyaedt = []
         # Retrieve the script arguments
         script_args = ScriptArgument.split()

ignore_words.txt

@@ -32,3 +32,4 @@ aline
 COM
 gRPC
 Toolkits
+Extensions