pyedb 0.2.0__py3-none-any.whl

pyedb/misc/downloads.py

@@ -0,0 +1,322 @@
+"""Download example datasets from https://github.com/pyansys/example-data"""
+import os
+import shutil
+import tempfile
+import zipfile
+
+from pyedb.generic.general_methods import is_ironpython, is_linux, settings
+from pyedb.misc.misc import list_installed_ansysem
+
+if is_ironpython:
+    import urllib
+else:
+    import urllib.request
+
+tmpfold = tempfile.gettempdir()
+EXAMPLE_REPO = "https://github.com/ansys/example-data/raw/master/"
+EXAMPLES_PATH = os.path.join(tmpfold, "PyAEDTExamples")
+
+
+def delete_downloads():
+    """Delete all downloaded examples to free space or update the files."""
+    shutil.rmtree(EXAMPLES_PATH, ignore_errors=True)
+
+
+def _get_file_url(directory, filename=None):
+    if not filename:
+        return EXAMPLE_REPO + "/".join([directory])
+    else:
+        return EXAMPLE_REPO + "/".join([directory, filename])
+
+
+def _retrieve_file(url, filename, directory, destination=None, local_paths=[]):  # pragma: no cover
+    """Download a file from a url"""
+    # First check if file has already been downloaded
+    if not destination:
+        destination = EXAMPLES_PATH
+    local_path = os.path.join(destination, directory, os.path.basename(filename))
+    local_path_no_zip = local_path.replace(".zip", "")
+    if os.path.isfile(local_path_no_zip) or os.path.isdir(local_path_no_zip):
+        local_paths.append(local_path_no_zip)
+
+    # grab the correct url retriever
+    if not is_ironpython:
+        urlretrieve = urllib.request.urlretrieve
+    destination_dir = os.path.join(destination, directory)
+    if not os.path.isdir(destination_dir):
+        os.makedirs(destination_dir)
+    # Perform download
+    if is_linux:
+        command = "wget {} -O {}".format(url, local_path)
+        os.system(command)
+    elif is_ironpython:
+        versions = list_installed_ansysem()
+        if versions:
+            cpython = os.listdir(os.path.join(os.getenv(versions[0]), "commonfiles", "CPython"))
+            command = (
+                '"'
+                + os.path.join(
+                    os.getenv(versions[0]),
+                    "commonfiles",
+                    "CPython",
+                    cpython[0],
+                    "winx64",
+                    "Release",
+                    "python",
+                    "python.exe",
+                )
+                + '"'
+            )
+            commandargs = os.path.join(os.path.dirname(local_path), "download.py")
+            command += ' "' + commandargs + '"'
+            with open(os.path.join(os.path.dirname(local_path), "download.py"), "w") as f:
+                f.write("import urllib.request\n")
+                f.write("urlretrieve = urllib.request.urlretrieve\n")
+                f.write("import urllib.request\n")
+                f.write('url = r"{}"\n'.format(url))
+                f.write('local_path = r"{}"\n'.format(local_path))
+                f.write("urlretrieve(url, local_path)\n")
+            print(command)
+            os.system(command)
+    else:
+        _, resp = urlretrieve(url, local_path)
+    local_paths.append(local_path)
+
+
+def _retrieve_folder(url, directory, destination=None, local_paths=[]):  # pragma: no cover
+    """Download a folder from a url"""
+    # First check if folder exists
+    import json
+    import re
+
+    if not destination:
+        destination = EXAMPLES_PATH
+    if directory.startswith("pyaedt/"):
+        local_path = os.path.join(destination, directory[7:])
+    else:
+        local_path = os.path.join(destination, directory)
+
+    if is_ironpython:
+        return False
+    _get_dir = _get_file_url(directory)
+    with urllib.request.urlopen(_get_dir) as response:  # nosec
+        data = response.read().decode("utf-8").split("\n")
+
+    if not os.path.isdir(local_path):
+        try:
+            os.mkdir(local_path)
+        except FileNotFoundError:
+            os.makedirs(local_path)
+
+    try:
+        tree = [i for i in data if '"payload"' in i][0]
+        b = re.search(r'>({"payload".+)</script>', tree)
+        itemsfromjson = json.loads(b.group(1))
+        items = itemsfromjson["payload"]["tree"]["items"]
+        for item in items:
+            if item["contentType"] == "directory":
+                _retrieve_folder(url, item["path"], destination, local_paths)
+            else:
+                dir_folder = os.path.split(item["path"])
+                _download_file(dir_folder[0], dir_folder[1], destination, local_paths)
+    except:
+        return False
+
+
+def _download_file(directory, filename=None, destination=None, local_paths=[]):  # pragma: no cover
+    if not filename:
+        if not directory.startswith("pyaedt/"):
+            directory = "pyaedt/" + directory
+        _retrieve_folder(EXAMPLE_REPO, directory, destination, local_paths)
+    else:
+        if directory.startswith("pyaedt/"):
+            url = _get_file_url(directory, filename)
+            directory = directory[7:]
+        else:
+            url = _get_file_url("pyaedt/" + directory, filename)
+        _retrieve_file(url, filename, directory, destination, local_paths)
+    if settings.remote_rpc_session:
+        remote_path = os.path.join(settings.remote_rpc_session_temp_folder, os.path.split(local_paths[-1])[-1])
+        if not settings.remote_rpc_session.filemanager.pathexists(settings.remote_rpc_session_temp_folder):
+            settings.remote_rpc_session.filemanager.makedirs(settings.remote_rpc_session_temp_folder)
+        settings.remote_rpc_session.filemanager.upload(local_paths[-1], remote_path)
+        local_paths[-1] = remote_path
+    return local_paths[-1]
+
+
+###############################################################################
+# front-facing functions
+
+
+def download_aedb(destination=None):  # pragma: no cover
+    """Download an example of AEDB File and return the def path.
+
+    Examples files are downloaded to a persistent cache to avoid
+    re-downloading the same file twice.
+
+    Parameters
+    ----------
+    destination : str, optional
+        Path for downloading files. The default is the user's temp folder.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file.
+    >>> import pyedb.misc.downloads
+    >>> path = pyedb.misc.downloads.download_aedb()
+    >>> path
+    'C:/Users/user/AppData/local/temp/Galileo.aedb'
+    """
+    local_paths = []
+    _download_file("pyaedt/edb/Galileo.aedb", "GRM32ER72A225KA35_25C_0V.sp", destination, local_paths)
+    _download_file("pyaedt/edb/Galileo.aedb", "edb.def", destination, local_paths)
+    return local_paths[-1]
+
+
+def download_edb_merge_utility(force_download=False, destination=None):  # pragma: no cover
+    """Download an example of WPF Project which allows to merge 2aedb files.
+
+    Examples files are downloaded to a persistent cache to avoid
+    re-downloading the same file twice.
+
+    Parameters
+    ----------
+    force_download : bool
+        Force to delete cache and download files again.
+    destination : str, optional
+        Path for downloading files. The default is the user's temp folder.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file.
+    >>> import pyedb.misc.downloads
+    >>> path = pyedb.misc.downloads.download_edb_merge_utility(force_download=True)
+    >>> path
+    'C:/Users/user/AppData/local/temp/wpf_edb_merge/merge_wizard.py'
+    """
+    if not destination:
+        destination = EXAMPLES_PATH
+    if force_download:
+        local_path = os.path.join(destination, "wpf_edb_merge")
+        if os.path.exists(local_path):
+            shutil.rmtree(local_path, ignore_errors=True)
+    local_paths = []
+    _download_file("pyaedt/wpf_edb_merge/board.aedb", "edb.def", destination, local_paths)
+    _download_file("pyaedt/wpf_edb_merge/package.aedb", "edb.def", destination, local_paths)
+    _download_file("pyaedt/wpf_edb_merge", "merge_wizard_settings.json", destination, local_paths)
+
+    _download_file("pyaedt/wpf_edb_merge", "merge_wizard.py", destination, local_paths)
+    return local_paths[0]
+
+
+def download_via_wizard(destination=None):  # pragma: no cover
+    """Download an example of Hfss Via Wizard and return the def path.
+
+    Examples files are downloaded to a persistent cache to avoid
+    re-downloading the same file twice.
+
+    Parameters
+    ----------
+    destination : str, optional
+        Path for downloading files. The default is the user's temp folder.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file.
+
+    >>> import pyedb.misc.downloads
+    >>> path = pyedb.misc.downloads.download_via_wizard()
+    >>> path
+    'C:/Users/user/AppData/local/temp/pyaedtexamples/Graphic_Card.aedt'
+    """
+
+    return _download_file("pyaedt/via_wizard", "viawizard_vacuum_FR4.aedt", destination)
+
+
+def download_touchstone(destination=None):  # pragma: no cover
+    """Download an example of touchstone File and return the def path.
+
+    Examples files are downloaded to a persistent cache to avoid
+    re-downloading the same file twice.
+
+    Parameters
+    ----------
+    destination : str, optional
+        Path for downloading files. The default is the user's temp folder.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file.
+    >>> import pyedb.misc.downloads
+    >>> path = pyedb.misc.downloads.download_touchstone()
+    >>> path
+    'C:/Users/user/AppData/local/temp/pyaedtexamples/ssn_ssn.s6p'
+    """
+    local_paths = []
+    _download_file("pyaedt/touchstone", "SSN_ssn.s6p", destination, local_paths)
+    return local_paths[0]
+
+
+def download_file(directory, filename=None, destination=None):  # pragma: no cover
+    """
+    Download file from directory.
+
+    Files are downloaded to a destination. If filename is not specified, the full directory will be downloaded.
+
+    Parameters
+    ----------
+    directory : str
+        Directory name.
+    filename : str, optional
+        File name to download. The default is all files inside directory.
+    destination : str, optional
+        Path where files will be downloaded. Default is user temp folder.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file.
+
+    >>> import pyedb.misc.downloads
+    >>> path = pyedb.misc.downloads.download_file("motorcad", "IPM_Vweb_Hairpin.mot")
+    >>> path
+    'C:/Users/user/AppData/local/temp/PyAEDTExamples/motorcad'
+    """
+    local_paths = []
+    _download_file(directory, filename, destination, local_paths)
+    if filename:
+        return list(set(local_paths))[0]
+    else:
+        if not destination:
+            destination = EXAMPLES_PATH
+        destination_dir = os.path.join(destination, directory)
+        return destination_dir
+
+
+def unzip(source_filename, dest_dir):
+    with zipfile.ZipFile(source_filename) as zf:
+        zf.extractall(dest_dir)

pyedb/misc/misc.py

@@ -0,0 +1,67 @@
+"""Miscellaneous Methods for PyEDB."""
+import os
+import warnings
+
+
+def list_installed_ansysem():
+    """Return a list of installed AEDT versions on ``ANSYSEM_ROOT``."""
+    aedt_env_var_prefix = "ANSYSEM_ROOT"
+    version_list = sorted([x for x in os.environ if x.startswith(aedt_env_var_prefix)], reverse=True)
+    aedt_env_var_sv_prefix = "ANSYSEMSV_ROOT"
+    version_list += sorted([x for x in os.environ if x.startswith(aedt_env_var_sv_prefix)], reverse=True)
+
+    if not version_list:
+        warnings.warn(
+            "No installed versions of AEDT are found in the system environment variables ``ANSYSEM_ROOTxxx``."
+        )
+
+    return version_list
+
+
+def installed_versions():
+    """Get the installed AEDT versions.
+
+    This method returns a dictionary, with version as the key and installation path
+    as the value."""
+
+    return_dict = {}
+    version_list = list_installed_ansysem()
+    for version_env_var in version_list:
+        if "ANSYSEMSV_ROOT" in version_env_var:
+            current_version_id = version_env_var.replace("ANSYSEMSV_ROOT", "")
+            student = True
+        else:
+            current_version_id = version_env_var.replace("ANSYSEM_ROOT", "")
+            student = False
+        try:
+            version = int(current_version_id[0:2])
+            release = int(current_version_id[2])
+            if version < 20:
+                if release < 3:
+                    version -= 1
+                else:
+                    release -= 2
+            if student:
+                v_key = "20{0}.{1}SV".format(version, release)
+            else:
+                v_key = "20{0}.{1}".format(version, release)
+            return_dict[v_key] = os.environ[version_env_var]
+        except:  # pragma: no cover
+            pass
+    return return_dict
+
+
+def current_version():
+    """Get the current AEDT version."""
+    try:
+        return list(installed_versions().keys())[0]
+    except (NameError, IndexError):
+        return ""
+
+
+def current_student_version():
+    """Get the current AEDT student version."""
+    for version_key in installed_versions():
+        if "SV" in version_key:
+            return version_key
+    return ""

pyedb/misc/pyedb.runtimeconfig.json

@@ -0,0 +1,13 @@
+{
+    "runtimeOptions": {
+      "tfm": "net3.1",
+      "framework": {
+        "name": "Microsoft.NETCore.App",
+        "version": "3.1.23"
+      },
+      "rollForward": "LatestPatch",
+      "configProperties": {
+        "System.Reflection.Metadata.MetadataUpdater.IsSupported": false
+      }
+    }
+  }

pyedb/misc/siw_feature_config/emc/component_tags.py

@@ -0,0 +1,46 @@
+from pyedb.misc.siw_feature_config.emc.xml_generic import \
+    XmlGeneric
+
+
+class Comp(XmlGeneric):
+    """Manages component tags."""
+
+    def __init__(self, element):
+        super().__init__(element)
+        if element is not None:
+            self.CompName = self._element.attrib["CompName"]
+            self.CompValue = self._element.attrib["CompValue"]
+            self.DeviceName = self._element.attrib["DeviceName"]
+            self.capType = self._element.attrib["capType"] if "capType" in self._element.attrib else None
+            self.isClockDriver = self._element.attrib["isClockDriver"]
+            self.isHighSpeed = self._element.attrib["isHighSpeed"]
+            self.isIC = self._element.attrib["isIC"]
+            self.isOscillator = self._element.attrib["isOscillator"]
+            self.xLoc = self._element.attrib["xLoc"]
+            self.yLoc = self._element.attrib["yLoc"]
+        else:
+            self.CompName = None
+            self.CompValue = None
+            self.DeviceName = None
+            self.capType = None
+            self.isClockDriver = None
+            self.isHighSpeed = None
+            self.isIC = None
+            self.isOscillator = None
+            self.xLoc = None
+            self.yLoc = None
+
+
+class ComponentTags(XmlGeneric):
+    """Manages component tags."""
+    CLS_MAPPING = {
+        "Comp": Comp
+    }
+
+    def __init__(self, element):
+        super().__init__(element)
+
+        if element:
+            for el in self._element.findall("Comp"):
+                comp = Comp(el)
+                self.sub_elements.append(comp)

pyedb/misc/siw_feature_config/emc/net_tags.py

@@ -0,0 +1,37 @@
+from pyedb.misc.siw_feature_config.emc.xml_generic import XmlGeneric
+
+
+class Net(XmlGeneric):
+    """Manages net."""
+
+    def __init__(self, element=None):
+        super().__init__(element)
+
+        if element is not None:
+            self.isBus = self._element.attrib["isBus"]
+            self.isClock = self._element.attrib["isClock"]
+            self.isCritical = self._element.attrib["isCritical"]
+            self.name = self._element.attrib["name"]
+            self.type = self._element.attrib["type"] if "type" in self._element.attrib else None
+        else:
+            self.isBus = None
+            self.isClock = None
+            self.isCritical = None
+            self.name = None
+            self.type = None
+
+
+class NetTags(XmlGeneric):
+    """Manages net tag."""
+
+    CLS_MAPPING = {
+        "Net": Net
+    }
+
+    def __init__(self, element):
+        super().__init__(element)
+
+        if element:
+            for el in self._element.findall("Net"):
+                net = Net(el)
+                self.sub_elements.append(net)

pyedb/misc/siw_feature_config/emc/tag_library.py

@@ -0,0 +1,62 @@
+from pyedb.misc.siw_feature_config.emc.xml_generic import XmlGeneric
+
+
+class TagType(XmlGeneric):
+    """Manages tag type."""
+    def __init__(self, element):
+        super().__init__(element)
+
+        if element is not None:
+            self.name = self._element.attrib["name"]
+        else:
+            self.name = None
+
+
+class TagConfig(XmlGeneric):
+    """Manages tag config."""
+    def __init__(self, element):
+        super().__init__(element)
+
+
+class Tag(XmlGeneric):
+    """Manages tag."""
+    CLS_MAPPING = {
+        "TagType": TagType,
+        "TagConfig": TagConfig
+    }
+
+    def __init__(self, element):
+        super().__init__(element)
+
+        if element is not None:
+            self.label = self._element.attrib["label"]
+            self.name = self._element.attrib["name"]
+            self.sub_elements = []
+
+            for el in self._element.findall("TagType"):
+                temp = TagType(el)
+                self.sub_elements.append(temp)
+
+            for el in self._element.findall("TagConfig"):
+                temp = TagConfig(el)
+                self.sub_elements.append(temp)
+        else:
+            self.label = None
+            self.name = None
+            self.sub_elements = []
+
+
+class TagLibrary(XmlGeneric):
+    """Manages tag library."""
+    CLS_MAPPING = {
+        "Tag": Tag,
+    }
+
+    def __init__(self, element):
+        super().__init__(element)
+        self._element = element
+
+        if element:
+            for el in self._element.findall("Tag"):
+                tag = Tag(el)
+                self.sub_elements.append(tag)

pyedb/misc/siw_feature_config/emc/xml_generic.py

@@ -0,0 +1,78 @@
+import re
+from pyedb.generic.general_methods import ET
+
+
+class XmlGeneric:
+    DEBUG = False
+    CLS_MAPPING = {}
+
+    def __init__(self, element):
+        self._element = element
+        self._cls_sub_element = None
+        self.sub_elements = []
+
+    def add_sub_element(self, kwargs, elem_type):
+        self._cls_sub_element = self.CLS_MAPPING[elem_type]
+        obj = self._cls_sub_element(None)
+        self.sub_elements.append(obj.create(kwargs))
+
+    def create(self, kwargs):
+        for attrib, value in kwargs.items():
+            if attrib in self.__dict__.keys():
+                if not isinstance(value, list):
+                    self.__setattr__(attrib, value)
+                else:
+                    for i in value:
+                        kwargs = list(i.values())[0]
+                        item_type = list(i.keys())[0]
+                        self.add_sub_element(kwargs, item_type)
+        return self
+
+    def write_xml(self, parent):
+        elem = ET.SubElement(parent, self.__class__.__name__)
+        for attrib, value in self.__dict__.items():
+            if attrib.startswith("_"):
+                continue
+            elif attrib.isupper():
+                continue
+            elif value is None:
+                continue
+            elif isinstance(value, list):
+                if len(value) == 0:
+                    continue
+                for i in value:
+                    i.write_xml(elem)
+            elif isinstance(value, str):
+                elem.set(attrib, value)
+            else:
+                raise Exception(f"{value} is Illegal")
+        return parent
+
+    def write_dict(self, parent):
+        temp = {}
+        for attrib, value in self.__dict__.items():
+            if attrib.startswith("_"):
+                continue
+            elif value is None:
+                continue
+
+            if isinstance(value, list):
+                if len(value) == 0:
+                    continue
+                new_list = []
+                for i in value:
+                    parent_2 = {}
+                    i.write_dict(parent_2)
+                    new_list.append(parent_2)
+                temp[attrib] = new_list
+            else:
+                temp[attrib] = value
+
+        parent[self.__class__.__name__] = temp
+
+    def read_dict(self, data):
+        for i in data["sub_elements"]:
+            elem_type = list(i.keys())[0]
+            kwargs = list(i.values())[0]
+            obj = self.CLS_MAPPING[elem_type](None)
+            self.sub_elements.append(obj.create(kwargs))