ansys-lumerical-core 0.1.0__tar.gz

ansys_lumerical_core-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ANSYS, Inc. All rights reserved.
+
+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.

ansys_lumerical_core-0.1.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: ansys-lumerical-core
+Version: 0.1.0
+Summary: Python interface to Ansys Lumerical
+Keywords: Ansys,Lumerical,photonics,simulation
+Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Requires-Python: >=3.10,<4
+Description-Content-Type: text/x-rst
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+License-File: LICENSE
+Requires-Dist: ansys-api-lumerical
+Requires-Dist: numpy>=1.26
+Requires-Dist: ansys-sphinx-theme[autoapi]==1.4.2 ; extra == "doc"
+Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
+Requires-Dist: sphinx==8.2.3 ; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
+Requires-Dist: sphinx_design==0.6.1 ; extra == "doc"
+Requires-Dist: matplotlib==3.10.0 ; extra == "examples"
+Requires-Dist: pytest==8.4.2 ; extra == "tests"
+Requires-Dist: pytest-cov==7.0.0 ; extra == "tests"
+Provides-Extra: doc
+Provides-Extra: examples
+Provides-Extra: tests
+
+PyLumerical
+===========
+|pyansys| |python| |pypi| |codecov| |GH-CI| |MIT| |ruff|
+
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-lumerical-core?logo=pypi
+   :target: https://pypi.org/project/ansys-lumerical-core/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-lumerical-core.svg?logo=python&logoColor=white&label=PyPI
+   :target: https://pypi.org/project/ansys-lumerical-core
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/github/ansys/pylumerical/graph/badge.svg?token=34FKDS6ZKJ
+   :target: https://codecov.io/github/ansys/pylumerical
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/pylumerical/actions/workflows/ci_cd_pr.yml/badge.svg
+   :target: https://github.com/ansys/pylumerical/actions/workflows/ci_cd_pr.yml
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :target: https://github.com/astral-sh/ruff
+   :alt: Ruff
+
+
+A Python wrapper for Ansys Lumerical products.
+
+Installing PyLumerical as a user
+--------------------------------
+
+You must have an Ansys Lumerical GUI license to use PyLumerical.
+
+You can install PyLumerical using pip.
+
+First, ensure that you have the latest pip version:
+
+.. code:: bash
+
+    python -m pip install -U pip
+
+Then, install using:
+
+.. code:: bash
+
+    python -m pip install ansys-lumerical-core
+
+For more information, see the `installation and getting started section <https://lumerical.docs.pyansys.com/version/stable/getting_started/index.html>`_ in the documentation.
+
+Contributing to PyLumerical
+---------------------------
+
+For guidelines on contribution and how to install PyLumerical as a developer, see the `contributing section <https://lumerical.docs.pyansys.com/version/stable/contributing.html>`_ section in the documentation.
+
+Getting started
+----------------
+
+Please see the `installation and getting started section <https://lumerical.docs.pyansys.com/version/stable/getting_started/index.html>`_ in the documentation for more information.
+

ansys_lumerical_core-0.1.0/README.rst

@@ -0,0 +1,64 @@
+PyLumerical
+===========
+|pyansys| |python| |pypi| |codecov| |GH-CI| |MIT| |ruff|
+
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-lumerical-core?logo=pypi
+   :target: https://pypi.org/project/ansys-lumerical-core/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-lumerical-core.svg?logo=python&logoColor=white&label=PyPI
+   :target: https://pypi.org/project/ansys-lumerical-core
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/github/ansys/pylumerical/graph/badge.svg?token=34FKDS6ZKJ
+   :target: https://codecov.io/github/ansys/pylumerical
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/pylumerical/actions/workflows/ci_cd_pr.yml/badge.svg
+   :target: https://github.com/ansys/pylumerical/actions/workflows/ci_cd_pr.yml
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :target: https://github.com/astral-sh/ruff
+   :alt: Ruff
+
+
+A Python wrapper for Ansys Lumerical products.
+
+Installing PyLumerical as a user
+--------------------------------
+
+You must have an Ansys Lumerical GUI license to use PyLumerical.
+
+You can install PyLumerical using pip.
+
+First, ensure that you have the latest pip version:
+
+.. code:: bash
+
+    python -m pip install -U pip
+
+Then, install using:
+
+.. code:: bash
+
+    python -m pip install ansys-lumerical-core
+
+For more information, see the `installation and getting started section <https://lumerical.docs.pyansys.com/version/stable/getting_started/index.html>`_ in the documentation.
+
+Contributing to PyLumerical
+---------------------------
+
+For guidelines on contribution and how to install PyLumerical as a developer, see the `contributing section <https://lumerical.docs.pyansys.com/version/stable/contributing.html>`_ section in the documentation.
+
+Getting started
+----------------
+
+Please see the `installation and getting started section <https://lumerical.docs.pyansys.com/version/stable/getting_started/index.html>`_ in the documentation for more information.

ansys_lumerical_core-0.1.0/pyproject.toml

@@ -0,0 +1,147 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "ansys-lumerical-core"
+dynamic = ["version"]
+description = "Python interface to Ansys Lumerical"
+readme = "README.rst"
+requires-python = ">=3.10,<4"
+license = "MIT"
+license_files = ["LICENSE"]
+authors=[
+    {name="ANSYS, Inc.", email="pyansys.core@ansys.com"}
+]
+maintainers=[
+    {name="ANSYS, Inc.", email="pyansys.core@ansys.com"}
+]
+keywords = ["Ansys", "Lumerical", "photonics", "simulation"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+dependencies = [
+    "ansys-api-lumerical",
+    "numpy>=1.26",
+]
+
+[project.optional-dependencies]
+tests = [
+    "pytest==8.4.2",
+    "pytest-cov==7.0.0",
+]
+doc = [
+    "ansys-sphinx-theme[autoapi]==1.4.2",
+    "numpydoc==1.8.0",
+    "sphinx==8.2.3",
+    "sphinx-copybutton==0.5.2",
+    "sphinx_design==0.6.1",
+]
+examples = [
+    "matplotlib==3.10.0",
+]
+
+[tool.flit.module]
+name = "ansys.lumerical.core"
+
+[tool.ruff]
+line-length = 150
+fix = true
+extend-exclude = ["tests/assets", "*.rst"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "D",    # pydocstyle, see https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "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
+]
+ignore = []
+
+[tool.ruff.lint.per-file-ignores]
+"examples/*" = ["D100", "E402"]
+"__init__.py" = ["F401"]
+"doc/source/conf.py" = ["N806"]
+
+[tool.ruff.lint.pep8-naming]
+ignore-names = [
+    "test_MODE_start_session",
+    "test_FDTD_start_session",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-sort-within-sections = true
+known-first-party = ["ansys.lumerical.core", "ansys.api.lumerical"]
+
+[tool.pydocstyle]
+convention = "numpy"
+
+[tool.coverage.run]
+source = ["ansys.lumerical"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.towncrier]
+package = "ansys.lumerical.core"
+directory = "doc/source/changelog"
+filename = "doc/source/changelog.rst"
+start_string = ".. towncrier release notes start\n"
+template = "doc/source/changelog/template"
+title_format = "`{version} <https://github.com/ansys/pylumerical/releases/tag/v{version}>`_ - {project_date}"
+issue_format = "`#{issue} <https://github.com/ansys/pylumerical/pull/{issue}>`_"
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "dependencies"
+name = "Dependencies"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "documentation"
+name = "Documentation"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "maintenance"
+name = "Maintenance"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "miscellaneous"
+name = "Miscellaneous"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "test"
+name = "Test"
+showcontent = true

ansys_lumerical_core-0.1.0/src/ansys/lumerical/core/__init__.py

@@ -0,0 +1,41 @@
+# Copyright (C) 2025 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.
+
+"""Set up the imports for PyLumerical."""
+
+import ansys.api.lumerical
+
+# Make common names from lumapi available in the top-level namespace
+from ansys.api.lumerical.lumapi import DEVICE, FDTD, INTERCONNECT, MODE, InteropPaths, SimObject, SimObjectId, SimObjectResults
+
+from . import autodiscovery
+
+__version__ = "0.1.0"
+"""Lumerical API version."""
+
+if len(ansys.api.lumerical.lumapi.InteropPaths.LUMERICALINSTALLDIR) == 0:
+    install_dir = autodiscovery.locate_lumerical_install()
+    if install_dir is not None:
+        ansys.api.lumerical.lumapi.InteropPaths.setLumericalInstallPath(install_dir)
+    else:
+        print("Lumerical installation not found. Please use InteropPaths.setLumericalInstallPath to set the interop library location.")
+    del install_dir  # remove the local variable to exclude from the namespace

ansys_lumerical_core-0.1.0/src/ansys/lumerical/core/autodiscovery.py

@@ -0,0 +1,119 @@
+# Copyright (C) 2025 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.
+
+"""Autodiscover the Lumerical installation directory."""
+
+from pathlib import Path
+import platform
+import re
+
+__min_supported_lum_release__ = {"year": 22, "release": 1}
+"""
+Supports Lumerical 2022R1 release and later.
+"""
+
+
+def locate_lumerical_install():
+    r"""
+    Locate the installation directory and interop library directory for Lumerical software.
+
+    This function attempts to identify the most recent installation path of Lumerical
+    software and its associated Python interop library directory based on the operating
+    system and predefined directory structures.
+
+    Returns
+    -------
+    str or None
+        The path to the Lumerical installation directory, or None if not found.
+
+    Raises
+    ------
+    RuntimeError
+        If the operating system is not Windows or Linux.
+
+    Notes
+    -----
+        - On Windows, the function first searches the registry, then searches under "C:\\Program Files\\Lumerical\\" and
+          "C:\\Program Files\\Ansys Inc\\Lumerical".
+        - On Linux, the function searches under "/opt/lumerical/" and "~/Ansys/ansys_inc/Lumerical".
+
+    Examples
+    --------
+        Example 1: Use autodiscovery to locate a Lumerical installation in a default location.
+
+        >>> import ansys.lumerical.core as lumapi
+        >>> # use lumapi ...
+
+        Example 2: Provide a custom installation path before importing the module.
+
+        >>> import ansys.api.lumerical.lumapi
+        >>> ansys.api.lumerical.lumapi.InteropPaths.setLumericalInstallPath(r"C:\Program Files\Lumerical\v252\")
+        >>> import ansys.lumerical.core as lumapi
+        >>> # use lumapi ...
+
+        Example 3: Provide a custom installation path after importing the module.
+
+        >>> import ansys.lumerical.core as lumapi
+        Warning: Lumerical installation not found. Please use InteropPaths.setLumericalInstallPath to set the interop library location.
+        >>> lumapi.InteropPaths.setLumericalInstallPath(r"C:\Program Files\Lumerical\v252\")
+        >>> # use lumapi ...
+    """
+    lumerical_install_dir = None
+
+    if platform.system() == "Windows":
+        try:
+            import winreg  # Import winreg here to avoid errors on non-Windows platforms
+
+            reg_path = r"SOFTWARE\ANSYS, Inc.\Lumerical"
+            with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, reg_path) as key:
+                install_folder, regtype = winreg.QueryValueEx(key, "installFolder")
+                if Path(install_folder).exists():
+                    return install_folder
+        except (FileNotFoundError, OSError):
+            pass
+        # if not found in the registry, try to guess the installation path
+        guess_base_and_suffix = [["C:\\Program Files\\Lumerical\\", ""], ["C:\\Program Files\\Ansys Inc\\", "Lumerical"]]
+    elif platform.system() == "Linux":
+        guess_base_and_suffix = [["/opt/lumerical/", ""], [str(Path("~/Ansys/ansys_inc/").expanduser()), "Lumerical"]]
+    else:
+        raise RuntimeError("Unsupported operating system. Only Windows and Linux are supported.")
+
+    # Find the latest installed version that is >= the required version
+    latest_ver_year = __min_supported_lum_release__["year"]
+    latest_ver_release = __min_supported_lum_release__["release"]
+
+    for guess_base, suffix in guess_base_and_suffix:
+        if Path(guess_base).exists():
+            for candidate_dir in Path(guess_base).iterdir():
+                if Path(candidate_dir, suffix).is_dir():
+                    match = re.match(r"v(\d{2})(\d)", candidate_dir.name)
+                    if match:
+                        ver_year = int(match.group(1))
+                        ver_maj = int(match.group(2))
+                        if ver_year > latest_ver_year or (ver_year == latest_ver_year and ver_maj >= latest_ver_release):
+                            latest_ver_year = ver_year
+                            latest_ver_release = ver_maj
+                            # check to make sure the api/python path is there (avoids some false positives from uninstalls)
+                            if Path(candidate_dir, suffix, "api/python/").exists():
+                                lumerical_install_dir = str(Path(candidate_dir, suffix))
+
+    return lumerical_install_dir