pyedb 0.56.0__tar.gz → 0.58.0__tar.gz

{pyedb-0.56.0 → pyedb-0.58.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyedb
-Version: 0.56.0
+Version: 0.58.0
 Summary: Higher-Level Pythonic Ansys Electronics Data Base
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: PyEDB developers <simon.vandenbrouck@ansys.com>
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 License-File: LICENSE
-Requires-Dist: cffi>=1.16.0,<1.18; platform_system=='Linux'
+Requires-Dist: cffi>=1.16.0,<2.1; platform_system=='Linux'
 Requires-Dist: pywin32 >= 303;platform_system=='Windows'
 Requires-Dist: ansys-pythonnet >= 3.1.0rc4
 Requires-Dist: dotnetcore2 ==3.1.23;platform_system=='Linux'
@@ -29,6 +29,8 @@ Requires-Dist: shapely
 Requires-Dist: scikit-rf
 Requires-Dist: ansys-edb-core>=0.2.0
 Requires-Dist: psutil
+Requires-Dist: defusedxml>=0.7,<8.0
+Requires-Dist: matplotlib>=3.5.0,<3.11
 Requires-Dist: ansys-sphinx-theme>=1.0.0,<1.5 ; extra == "doc"
 Requires-Dist: imageio>=2.30.0,<2.38 ; extra == "doc"
 Requires-Dist: ipython>=8.13.0,<8.32 ; extra == "doc"
@@ -41,18 +43,16 @@ Requires-Dist: numpydoc>=1.5.0,<1.9 ; extra == "doc"
 Requires-Dist: pypandoc>=1.10.0,<1.16 ; extra == "doc"
 Requires-Dist: recommonmark ; extra == "doc"
 Requires-Dist: Sphinx>=7.1.0,<8.2 ; extra == "doc"
-Requires-Dist: sphinx-autobuild==2021.3.14 ; extra == "doc" and ( python_version == '3.8')
+Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "doc" and ( python_version == '3.8')
 Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "doc" and ( python_version > '3.8')
 Requires-Dist: sphinx-copybutton>=0.5.0,<0.6 ; extra == "doc"
 Requires-Dist: sphinx-gallery>=0.14.0,<0.20 ; extra == "doc"
 Requires-Dist: sphinx_design>=0.4.0,<0.7 ; extra == "doc"
 Requires-Dist: shapely ; extra == "doc"
-Requires-Dist: matplotlib>=3.5.0,<3.11 ; extra == "full"
-Requires-Dist: shapely ; extra == "full"
 Requires-Dist: matplotlib>=3.5.0,<3.11 ; extra == "tests"
 Requires-Dist: mock>=5.1.0,<5.3 ; extra == "tests"
 Requires-Dist: pytest>=7.4.0,<8.5 ; extra == "tests"
-Requires-Dist: pytest-cov>=4.0.0,<6.3 ; extra == "tests"
+Requires-Dist: pytest-cov>=4.0.0,<7.1 ; extra == "tests"
 Requires-Dist: pytest-xdist>=3.5.0,<3.7 ; extra == "tests"
 Requires-Dist: scikit-rf ; extra == "tests"
 Requires-Dist: shapely ; extra == "tests"
@@ -62,7 +62,6 @@ Project-URL: Documentation, https://edb.docs.pyansys.com
 Project-URL: Releases, https://github.com/ansys/pyedb/releases
 Project-URL: Source, https://github.com/ansys/pyedb
 Provides-Extra: doc
-Provides-Extra: full
 Provides-Extra: tests
 
 <!-- -->

pyedb-0.58.0/pyproject.toml

@@ -0,0 +1,266 @@
+[build-system]
+requires = ["flit_core >=3.2,<3.13"] # THIS SHOULD BE REVERTED TO '["flit_core >=3.2,<4"]'
+build-backend = "flit_core.buildapi"
+
+
+[project]
+name = "pyedb"
+dynamic = ["version"]
+description = "Higher-Level Pythonic Ansys Electronics Data Base"
+readme = "README.md"
+requires-python = ">=3.8,<4"
+license = {file = "LICENSE"}
+authors = [{name = "ANSYS, Inc.", email = "pyansys.core@ansys.com"}]
+maintainers = [{name = "PyEDB developers", email = "simon.vandenbrouck@ansys.com"}]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+
+dependencies = [
+    "cffi>=1.16.0,<2.1; platform_system=='Linux'",
+    "pywin32 >= 303;platform_system=='Windows'",
+    "ansys-pythonnet >= 3.1.0rc4",
+    "dotnetcore2 ==3.1.23;platform_system=='Linux'",
+    "numpy>=1.20.0,<3",
+    "pandas>=1.1.0,<2.4",
+    "pydantic>=2.6.4,<2.12",
+    "Rtree >= 1.2.0",
+    "toml == 0.10.2",
+    "shapely",
+    "scikit-rf",
+    "ansys-edb-core>=0.2.0",
+    "psutil",
+    "defusedxml>=0.7,<8.0",
+    "matplotlib>=3.5.0,<3.11",
+]
+
+[project.optional-dependencies]
+tests = [
+    "matplotlib>=3.5.0,<3.11",
+    "mock>=5.1.0,<5.3",
+    "pytest>=7.4.0,<8.5",
+    "pytest-cov>=4.0.0,<7.1",
+    "pytest-xdist>=3.5.0,<3.7",
+    "scikit-rf",
+    "shapely"
+]
+doc = [
+    "ansys-sphinx-theme>=1.0.0,<1.5",
+    "imageio>=2.30.0,<2.38",
+    "ipython>=8.13.0,<8.32",
+    "jupyterlab>=4.0.0,<4.5",
+    "jupytext>=1.16.0,<1.18",
+    "matplotlib>=3.5.0,<3.11",
+    "nbsphinx>=0.9.0,<0.10",
+    "nbconvert < 7.17",
+    "numpydoc>=1.5.0,<1.9",
+    "pypandoc>=1.10.0,<1.16",
+    # NOTE: Remove recommonmark once examples are reworked.
+    "recommonmark",
+    "Sphinx>=7.1.0,<8.2",
+    "sphinx-autobuild==2024.10.3; python_version == '3.8'",
+    "sphinx-autobuild==2024.10.3; python_version > '3.8'",
+    "sphinx-copybutton>=0.5.0,<0.6",
+    "sphinx-gallery>=0.14.0,<0.20",
+    "sphinx_design>=0.4.0,<0.7",
+    "shapely",
+]
+
+
+[tool.flit.module]
+name = "pyedb"
+
+[project.urls]
+Bugs = "https://github.com/ansys/pyedb/issues"
+Documentation = "https://edb.docs.pyansys.com"
+Source = "https://github.com/ansys/pyedb"
+Discussions = "https://github.com/ansys/pyedb/discussions"
+ Releases = "https://github.com/ansys/pyedb/releases"
+
+[tool.ruff]
+line-length = 120
+fix = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = [
+    "D",   # pydocstyle, see https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "E",   # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "F",   # pyflakes, see https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "I",   # isort, see https://docs.astral.sh/ruff/rules/#isort-i
+    "N",   # pep8-naming, see https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "PTH", # flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "TD",  # flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
+    "W",   # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+]
+ignore = [
+    # "D" - pydocstyle, see https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "D100", # undocumented-public-module
+    "D101", # undocumented-public-class
+    "D102", # undocumented-public-method
+    "D103", # undocumented-public-function
+    "D104", # undocumented-public-package
+    "D105", # undocumented-magic-method
+    "D106", # undocumented-public-nested-class
+    "D200", # unnecessary-multiline-docstring
+    "D202", # blank-line-after-function
+    "D205", # missing-blank-line-after-summary
+    "D208", # over-indentation
+    "D209", # new-line-after-last-paragraph
+    "D210", # surrounding-whitespace
+    "D214", # overindented-section
+    "D215", # overindented-section-underline
+    "D301", # escape-sequence-in-docstring
+    "D400", # missing-trailing-period
+    "D401", # non-imperative-mood
+    "D403", # first-word-uncapitalized
+    "D404", # docstring-starts-with-this
+    "D405", # non-capitalized-section-name
+    "D406", # missing-new-line-after-section-name
+    "D407", # missing-dashed-underline-after-section
+    "D409", # mismatched-section-underline-length
+    "D410", # no-blank-line-after-section
+    "D411", # no-blank-line-before-section
+    "D412", # blank-lines-between-header-and-content
+    "D414", # empty-docstring-section
+    "D419", # empty-docstring
+
+    # "E" - pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "E402", # module-import-not-at-top-of-file
+    "E711", # none-comparison
+    "E712", # true-false-comparison
+    "E713", # not-in-test
+    "E721", # type-comparison
+    "E722", # bare-except
+    "E731", # lambda-assignment
+    "E741", # ambiguous-variable-name
+    "E743", # ambiguous-function-name
+
+    # "F" - pyflakes, see https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "F401", # unused-import
+    "F523", # string-dot-format-extra-positional-arguments
+    "F541", # f-string-missing-placeholders
+    "F811", # redefined-while-unused
+    "F821", # undefined-name
+    "F841", # unused-variable
+
+    # "N" - pep8-naming, see https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "N801", # invalid-class-name
+    "N802", # invalid-function-name
+    "N803", # invalid-argument-name
+    "N806", # non-lowercase-variable-in-function
+    "N812", # lowercase-imported-as-non-lowercase
+    "N813", # camelcase-imported-as-lowercase
+    "N815", # mixed-case-variable-in-class-scope
+    "N816", # mixed-case-variable-in-global-scope
+    "N817", # camelcase-imported-as-acronym
+    "N818", # error-suffix-on-exception-name
+    "N999", # invalid-module-name
+
+    # "PTH" - flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "PTH100", # os-path-abspath
+    "PTH101", # os-chmod
+    "PTH102", # os-mkdir
+    "PTH103", # os-makedirs
+    "PTH104", # os-rename
+    "PTH107", # os-remove
+    "PTH108", # os-unlink
+    "PTH110", # os-path-exists
+    "PTH111", # os-path-expanduser
+    "PTH112", # os-path-isdir
+    "PTH113", # os-path-isfile
+    "PTH116", # os-stat
+    "PTH118", # os-path-join
+    "PTH119", # os-path-basename
+    "PTH120", # os-path-dirname
+    "PTH122", # os-path-splitext
+    "PTH123", # builtin-open
+    "PTH202", # os-path-getsize
+
+    # "TD" - flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
+    "TD001", # invalid-todo-tag
+    "TD002", # missing-todo-author
+    "TD003", # missing-todo-link
+    "TD004", # missing-todo-colon
+    "TD005", # missing-todo-description
+    "TD006", # invalid-todo-capitalization
+
+    # "W" - pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "W605" # invalid-escape-sequence
+]
+
+[tool.ruff.lint.pydocstyle]
+# Use Numpy-style docstrings.
+convention = "numpy"
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = ["doc", "src", "tests"]
+combine-as-imports = true
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.codespell]
+skip = '*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,*.a3dcomp,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,*.cdb,*.CDB,build,./factory/*,PKG-INFO,*.mypy_cache/*,./_unused/*,pyproject.toml'
+ignore-words = "doc/styles/config/vocabularies/ANSYS/accept.txt"
+ignore-words-list = "renabled, sie, mot"
+enable-colors = true
+
+[tool.coverage.run]
+relative_files = true
+source = ["pyedb"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.pytest.ini_options]
+minversion = "7.1"
+xfail_strict = false
+filterwarnings = [
+    "ignore::DeprecationWarning",
+]
+markers = [
+    "legacy: mark test as related to the legacy API.",
+    "grpc: mark test as related to the gRPC API.",
+    "unit: mark test as an unit test.",
+    "integration: mark test as an integration test.",
+    "system: mark test as a system test.",
+    "slow: mark test as slow.",
+    "no_licence: mark test that do not need a licence.",
+]
+testpaths = "tests"
+#addopts = "-ra --cov=src/pyedb --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv"
+
+[tool.numpydoc_validation]
+checks = [
+    "GL06",  # Found unknown section
+    "GL07",  # Sections are in the wrong order.
+    "GL08",  # The object does not have a docstring
+    "GL09",  # Deprecation warning should precede extended summary
+    "GL10",  # reST directives {directives} must be followed by two colons
+    # Return
+    "RT04", # Return value description should start with a capital letter"
+    "RT05", # Return value description should finish with "."
+    # Summary
+    "SS01",  # No summary found
+    "SS02",  # Summary does not start with a capital letter
+    "SS03",  # Summary does not end with a period
+    "SS04",  # Summary contains heading whitespaces
+    "SS05",  # Summary must start with infinitive verb, not third person
+    # Parameters
+    "PR10",  # Parameter "{param_name}" requires a space before the colon
+    # separating the parameter name and type",
+]

{pyedb-0.56.0 → pyedb-0.58.0}/src/pyedb/__init__.py

@@ -37,7 +37,7 @@ deprecation_warning()
 #
 
 pyedb_path = os.path.dirname(__file__)
-__version__ = "0.56.0"
+__version__ = "0.58.0"
 version = __version__
 
 #

{pyedb-0.56.0 → pyedb-0.58.0}/src/pyedb/configuration/cfg_data.py

@@ -36,6 +36,7 @@ from pyedb.configuration.cfg_s_parameter_models import CfgSParameters
 from pyedb.configuration.cfg_setup import CfgSetups
 from pyedb.configuration.cfg_spice_models import CfgSpiceModel
 from pyedb.configuration.cfg_stackup import CfgStackup
+from pyedb.configuration.cfg_terminals import CfgTerminals
 
 
 class CfgData(object):
@@ -59,6 +60,8 @@ class CfgData(object):
 
         self.pin_groups = CfgPinGroups(self._pedb, pingroup_data=kwargs.get("pin_groups", []))
 
+        self.terminals = CfgTerminals.create(terminals=kwargs.get("terminals", []))
+
         self.ports = CfgPorts(self._pedb, ports_data=kwargs.get("ports", []))
 
         self.sources = CfgSources(self._pedb, sources_data=kwargs.get("sources", []))

{pyedb-0.56.0 → pyedb-0.58.0}/src/pyedb/configuration/cfg_pin_groups.py

@@ -35,6 +35,8 @@ class CfgPinGroups:
         layout_pin_groups = self._pedb.siwave.pin_groups
         for pg_name, pg_obj in layout_pin_groups.items():
             pins = list(pg_obj.pins.keys())
+            if len(pins) == 0:  # pragma: no cover
+                continue
             refdes = list(pg_obj.pins.values())[0].component.name
             cfg_pg = CfgPinGroup(
                 self._pedb,

pyedb-0.58.0/src/pyedb/configuration/cfg_terminals.py

@@ -0,0 +1,232 @@
+from typing import List, Literal, Optional, Union
+
+from pydantic import BaseModel
+
+
+class CfgBase(BaseModel):
+    model_config = {
+        "populate_by_name": True,
+        "extra": "forbid",
+    }
+
+
+class CfgTerminal(CfgBase):
+    name: str
+    impedance: Union[float, int, str]
+    is_circuit_port: bool
+    reference_terminal: Optional[str] = None
+    amplitude: Optional[Union[float, int, str]] = 1
+    phase: Optional[Union[float, int, str]] = 0
+    terminal_to_ground: Optional[Literal["kNoGround", "kNegative", "kPositive"]] = "kNoGround"
+    boundary_type: Literal[
+        "PortBoundary",
+        "PecBoundary",
+        "RlcBoundary",
+        "kCurrentSource",
+        "kVoltageSource",
+        "kNexximGround",
+        "kNexximPort",
+        "kDcTerminal",
+        "kVoltageProbe",
+        "InvalidBoundary",
+    ]
+    hfss_type: Literal["Wave", "Gap", None]
+
+
+class CfgPadstackInstanceTerminal(CfgTerminal):
+    terminal_type: str = "padstack_instance"
+    padstack_instance: str
+    padstack_instance_id: Optional[int] = None
+    layer: Optional[Union[str, None]] = None
+
+
+class CfgPinGroupTerminal(CfgTerminal):
+    terminal_type: str = "pin_group"
+    is_circuit_port: bool = True
+    pin_group: str
+
+
+class CfgPointTerminal(CfgTerminal):
+    terminal_type: str = "point"
+    x: Union[float, int, str]
+    y: Union[float, int, str]
+    layer: str
+    net: str
+
+
+class CfgEdgeTerminal(CfgTerminal):
+    terminal_type: str = "edge"
+    name: str
+    primitive: str
+    point_on_edge_x: Union[float, int, str]
+    point_on_edge_y: Union[float, int, str]
+    horizontal_extent_factor: Union[int, str]
+    vertical_extent_factor: Union[int, str]
+    pec_launch_width: Union[int, str]
+
+
+class CfgBundleTerminal(CfgBase):
+    terminal_type: str = "bundle"
+    terminals: List[str]
+    name: str
+
+
+class CfgTerminals(CfgBase):
+    terminals: List[
+        Union[
+            CfgPadstackInstanceTerminal, CfgPinGroupTerminal, CfgPointTerminal, CfgEdgeTerminal, CfgBundleTerminal, dict
+        ]
+    ]
+
+    @classmethod
+    def create(cls, terminals: List[dict]):
+        manager = cls(terminals=[])
+        for i in terminals:
+            terminal_type = i.pop("terminal_type")
+            if terminal_type == "padstack_instance":
+                manager.add_padstack_instance_terminal(**i)
+            elif terminal_type == "pin_group":
+                manager.add_pin_group_terminal(**i)
+            elif terminal_type == "point":
+                manager.add_point_terminal(**i)
+            elif terminal_type == "edge":
+                manager.add_edge_terminal(**i)
+            elif terminal_type == "bundle":
+                manager.add_bundle_terminal(**i)
+            else:  # pragma: no cover
+                raise ValueError(f"Unknown terminal type: {terminal_type}")
+        return manager
+
+    def add_padstack_instance_terminal(
+        self,
+        padstack_instance,
+        name,
+        impedance,
+        is_circuit_port,
+        boundary_type,
+        hfss_type,
+        reference_terminal=None,
+        amplitude=1,
+        phase=0,
+        terminal_to_ground="kNoGround",
+        padstack_instance_id=None,
+        layer=None,
+    ):
+        terminal = CfgPadstackInstanceTerminal(
+            padstack_instance=padstack_instance,
+            name=name,
+            impedance=impedance,
+            is_circuit_port=is_circuit_port,
+            boundary_type=boundary_type,
+            reference_terminal=reference_terminal,
+            amplitude=amplitude,
+            phase=phase,
+            terminal_to_ground=terminal_to_ground,
+            layer=layer,
+            hfss_type=hfss_type,
+            padstack_instance_id=padstack_instance_id,
+        )
+        self.terminals.append(terminal)
+
+    def add_pin_group_terminal(
+        self,
+        pin_group,
+        name,
+        impedance,
+        boundary_type,
+        reference_terminal=None,
+        amplitude=1,
+        phase=0,
+        terminal_to_ground="kNoGround",
+    ):
+        terminal = CfgPinGroupTerminal(
+            pin_group=pin_group,
+            name=name,
+            impedance=impedance,
+            is_circuit_port=True,
+            boundary_type=boundary_type,
+            reference_terminal=reference_terminal,
+            amplitude=amplitude,
+            phase=phase,
+            terminal_to_ground=terminal_to_ground,
+            hfss_type=None,
+        )
+        self.terminals.append(terminal)
+
+    def add_point_terminal(
+        self,
+        x,
+        y,
+        layer,
+        name,
+        impedance,
+        boundary_type,
+        net,
+        reference_terminal=None,
+        amplitude=1,
+        phase=0,
+        terminal_to_ground="kNoGround",
+    ):
+        terminal = CfgPointTerminal(
+            x=x,
+            y=y,
+            layer=layer,
+            name=name,
+            impedance=impedance,
+            is_circuit_port=True,
+            boundary_type=boundary_type,
+            reference_terminal=reference_terminal,
+            amplitude=amplitude,
+            phase=phase,
+            net=net,
+            terminal_to_ground=terminal_to_ground,
+            hfss_type=None,
+        )
+        self.terminals.append(terminal)
+
+    def add_edge_terminal(
+        self,
+        name,
+        impedance,
+        is_circuit_port,
+        boundary_type,
+        primitive,
+        point_on_edge_x,
+        point_on_edge_y,
+        horizontal_extent_factor=6,
+        vertical_extent_factor=8,
+        pec_launch_width="0.02mm",
+        reference_terminal=None,
+        amplitude=1,
+        phase=0,
+        terminal_to_ground="kNoGround",
+    ):
+        terminal = CfgEdgeTerminal(
+            name=name,
+            impedance=impedance,
+            is_circuit_port=is_circuit_port,
+            boundary_type=boundary_type,
+            reference_terminal=reference_terminal,
+            amplitude=amplitude,
+            phase=phase,
+            terminal_to_ground=terminal_to_ground,
+            primitive=primitive,
+            point_on_edge_x=point_on_edge_x,
+            point_on_edge_y=point_on_edge_y,
+            horizontal_extent_factor=horizontal_extent_factor,
+            vertical_extent_factor=vertical_extent_factor,
+            pec_launch_width=pec_launch_width,
+            hfss_type="Wave",
+        )
+        self.terminals.append(terminal)
+
+    def add_bundle_terminal(
+        self,
+        terminals,
+        name,
+    ):
+        terminal = CfgBundleTerminal(
+            terminals=terminals,
+            name=name,
+        )
+        self.terminals.append(terminal)