ansys-sherlock-core 0.2.0__tar.gz

ansys_sherlock_core-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 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_sherlock_core-0.2.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.1
+Name: ansys-sherlock-core
+Version: 0.2.0
+Summary: A python wrapper for Ansys Sherlock
+Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Requires-Python: >=3.8,<4
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: ansys-api-sherlock==0.1.14
+Requires-Dist: grpcio>=1.17
+Requires-Dist: importlib-metadata>=4.0,<5; python_version<='3.8'
+Requires-Dist: protobuf~=3.20
+Requires-Dist: ansys-sphinx-theme==0.9.9 ; extra == "doc"
+Requires-Dist: numpydoc==1.5.0 ; extra == "doc"
+Requires-Dist: Sphinx==6.2.1 ; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
+Requires-Dist: sphinx_design==0.4.1 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.13.0 ; extra == "doc"
+Requires-Dist: grpcio==1.55.0 ; extra == "tests"
+Requires-Dist: protobuf==3.20.3 ; extra == "tests"
+Requires-Dist: pytest==7.3.2 ; extra == "tests"
+Requires-Dist: pytest-cov==4.1.0 ; extra == "tests"
+Project-URL: Documentation, https://sherlock.docs.pyansys.com
+Project-URL: Homepage, https://github.com/ansys/pysherlock
+Project-URL: Source, https://github.com/ansys/pysherlock
+Project-URL: Tracker, https://github.com/ansys/pysherlock/issues
+Provides-Extra: doc
+Provides-Extra: tests
+
+PySherlock
+==========
+|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
+
+.. |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-sherlock-core?logo=pypi
+   :target: https://pypi.org/project/ansys-sherlock-core/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-sherlock-core.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-sherlock-core
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/gh/ansys/ansys-sherlock-core/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/pysherlock
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/pysherlock/actions/workflows/ci_cd.yml/badge.svg
+   :target: https://github.com/ansys/pysherlock/actions/workflows/ci_cd.yml
+   :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+   :target: https://github.com/psf/black
+   :alt: Black
+
+PySherlock is a Python client library for the Ansys Sherlock product.
+
+.. readme_start
+
+Overview
+--------
+Ansys Sherlock is a reliability physics-based electronics design tool that provides
+fast and accurate life predictions for electronic hardware at the component,
+board, and system levels in early stage design.
+
+PySherlock provides Pythonic access to Sherlock's functions, enabling
+users to automate and customize their specific workflows.
+
+With PySherlock, you can perform many tasks, including these:
+
+* Launch a Sherlock gRPC server and a Sherlock client.
+* Import ECAD files and generate project reports.
+* Define life cycle events and profiles.
+* Generate a stackup and update a stackup layer.
+* Update a project parts list.
+* Perform layer view operations such as updating a mount point's location.
+* Export a trace or trace reinforcement model for integration with Ansys Workbench.
+* Execute one or more analyses.
+
+Dependencies
+------------
+
+You must have a licensed copy of `Ansys Sherlock <https://www.ansys.com/products/structures/ansys-sherlock>`_
+installed either on your local machine or a remote machine. To use a remote session, a connection to the
+remote machine must be available from your Python program.
+
+Documentation and issues
+------------------------
+For comprehensive information on PySherlock, see the latest release
+`documentation <https://sherlock.docs.pyansys.com/>`_.
+
+On the `PySherlock Issues <https://github.com/ansys/pysherlock/issues>`_ page,
+you can create issues to submit questions, report bugs, and request new features.
+This is the best place to post questions and code.
+
+Contributing
+------------
+If you would like to test or contribute to the development of PySherlock, see
+`Contribute <https://sherlock.docs.pyansys.com/version/dev/contributing.html>`_ in the
+PySherlock documentation.
+
+License
+-------
+PySherlock is licensed under the MIT license.
+
+PySherlock makes no commercial claim over Ansys whatsoever. This library extends the functionality
+of Ansys Sherlock by adding a Python interface to Sherlock without changing the core behavior
+or license of the original software. The use of the interactive control of PySherlock requires
+a legally licensed copy of Sherlock.
+
+For more information on Sherlock, see the `Ansys Sherlock <https://www.ansys.com/products/structures/ansys-sherlock>`_
+page on the Ansys website.
+

ansys_sherlock_core-0.2.0/README.rst

@@ -0,0 +1,89 @@
+PySherlock
+==========
+|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
+
+.. |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-sherlock-core?logo=pypi
+   :target: https://pypi.org/project/ansys-sherlock-core/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-sherlock-core.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-sherlock-core
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/gh/ansys/ansys-sherlock-core/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/pysherlock
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/pysherlock/actions/workflows/ci_cd.yml/badge.svg
+   :target: https://github.com/ansys/pysherlock/actions/workflows/ci_cd.yml
+   :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+   :target: https://github.com/psf/black
+   :alt: Black
+
+PySherlock is a Python client library for the Ansys Sherlock product.
+
+.. readme_start
+
+Overview
+--------
+Ansys Sherlock is a reliability physics-based electronics design tool that provides
+fast and accurate life predictions for electronic hardware at the component,
+board, and system levels in early stage design.
+
+PySherlock provides Pythonic access to Sherlock's functions, enabling
+users to automate and customize their specific workflows.
+
+With PySherlock, you can perform many tasks, including these:
+
+* Launch a Sherlock gRPC server and a Sherlock client.
+* Import ECAD files and generate project reports.
+* Define life cycle events and profiles.
+* Generate a stackup and update a stackup layer.
+* Update a project parts list.
+* Perform layer view operations such as updating a mount point's location.
+* Export a trace or trace reinforcement model for integration with Ansys Workbench.
+* Execute one or more analyses.
+
+Dependencies
+------------
+
+You must have a licensed copy of `Ansys Sherlock <https://www.ansys.com/products/structures/ansys-sherlock>`_
+installed either on your local machine or a remote machine. To use a remote session, a connection to the
+remote machine must be available from your Python program.
+
+Documentation and issues
+------------------------
+For comprehensive information on PySherlock, see the latest release
+`documentation <https://sherlock.docs.pyansys.com/>`_.
+
+On the `PySherlock Issues <https://github.com/ansys/pysherlock/issues>`_ page,
+you can create issues to submit questions, report bugs, and request new features.
+This is the best place to post questions and code.
+
+Contributing
+------------
+If you would like to test or contribute to the development of PySherlock, see
+`Contribute <https://sherlock.docs.pyansys.com/version/dev/contributing.html>`_ in the
+PySherlock documentation.
+
+License
+-------
+PySherlock is licensed under the MIT license.
+
+PySherlock makes no commercial claim over Ansys whatsoever. This library extends the functionality
+of Ansys Sherlock by adding a Python interface to Sherlock without changing the core behavior
+or license of the original software. The use of the interactive control of PySherlock requires
+a legally licensed copy of Sherlock.
+
+For more information on Sherlock, see the `Ansys Sherlock <https://www.ansys.com/products/structures/ansys-sherlock>`_
+page on the Ansys website.

ansys_sherlock_core-0.2.0/pyproject.toml

@@ -0,0 +1,82 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "ansys-sherlock-core"
+version = "0.2.0"
+description = "A python wrapper for Ansys Sherlock"
+readme = "README.rst"
+requires-python = ">=3.8,<4"
+license = {file = "LICENSE"}
+authors = [{name = "ANSYS, Inc.", email = "pyansys.core@ansys.com"}]
+maintainers = [{name = "ANSYS, Inc.", email = "pyansys.core@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 = [
+    "ansys-api-sherlock==0.1.14",
+    "grpcio>=1.17",
+    "importlib-metadata>=4.0,<5; python_version<='3.8'",
+    "protobuf~=3.20",
+]
+
+[project.optional-dependencies]
+tests = [
+    "grpcio==1.55.0",
+    "protobuf==3.20.3",
+    "pytest==7.3.2",
+    "pytest-cov==4.1.0",
+]
+doc = [
+    "ansys-sphinx-theme==0.9.9",
+    "numpydoc==1.5.0",
+    "Sphinx==6.2.1", # BLOCKED BY sphinx-design - Cannot upgrade to Sphinx 7 for now
+    "sphinx-copybutton==0.5.2",
+    "sphinx_design==0.4.1",
+    "sphinx-gallery==0.13.0",
+]
+
+[project.urls]
+Documentation = "https://sherlock.docs.pyansys.com"
+Homepage = "https://github.com/ansys/pysherlock"
+Source = "https://github.com/ansys/pysherlock"
+Tracker = "https://github.com/ansys/pysherlock/issues"
+
+[tool.flit.module]
+name = "ansys.sherlock.core"
+
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = "black"
+force_sort_within_sections = true
+line_length = 100
+default_section = "THIRDPARTY"
+src_paths = ["doc", "src", "tests"]
+
+[tool.coverage.run]
+source = ["ansys.sherlock"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.pytest.ini_options]
+minversion = "7.1"
+testpaths = [
+    "tests",
+]
+
+[tool.codespell]
+ignore-words = "doc/styles/Vocab/ANSYS/accept.txt"
+quiet-level = 3

ansys_sherlock_core-0.2.0/src/ansys/sherlock/core/__init__.py

@@ -0,0 +1,22 @@
+# © 2023 ANSYS, Inc. All rights reserved.
+
+"""PySherlock client library."""
+
+# Version
+# ------------------------------------------------------------------------------
+
+try:
+    import importlib.metadata as importlib_metadata
+except ModuleNotFoundError:  # pragma: no cover
+    import importlib_metadata  # type: ignore
+
+__version__ = importlib_metadata.version(__name__.replace(".", "-"))
+"""PySherlock version."""
+
+# Ease import statements
+# ------------------------------------------------------------------------------
+
+from ansys.sherlock.core.logging import Logger
+
+LOG = Logger("sherlock")
+"""PySherlock logger."""