ansys-workbench-core 0.4.0__tar.gz

ansys_workbench_core-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+
+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_workbench_core-0.4.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.1
+Name: ansys-workbench-core
+Version: 0.4.0
+Summary: A python wrapper for Ansys Workbench
+Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Requires-Python: >=3.9,<4.0
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: ansys_api_workbench>=0.2.0
+Requires-Dist: ansys-platform-instancemanagement>=1.0.1
+Requires-Dist: ansys-pythonnet>=3.1.0rc1
+Requires-Dist: ansys-tools-path>=0.3.1
+Requires-Dist: tqdm>=4.65.0
+Requires-Dist: WMI>=1.4.9
+Requires-Dist: ansys-sphinx-theme[autoapi]==0.16.5 ; extra == "doc"
+Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
+Requires-Dist: Sphinx==7.3.7 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.1.1 ; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
+Requires-Dist: pytest==8.2.2 ; extra == "tests"
+Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
+Requires-Dist: bandit==1.7.8 ; extra == "vulnerabilities"
+Requires-Dist: safety==3.2.3 ; extra == "vulnerabilities"
+Project-URL: Documentation, https://workbench.docs.pyansys.com
+Project-URL: Homepage, https://github.com/ansys/pyworkbench
+Project-URL: Source, https://github.com/ansys/pyworkbench
+Project-URL: Tracker, https://github.com/ansys/pyworkbench/issues
+Provides-Extra: doc
+Provides-Extra: tests
+Provides-Extra: vulnerabilities
+
+PyWorkbench
+===========
+
+|pyansys| |python| |pypi| |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-workbench-core?logo=pypi
+   :target: https://pypi.org/project/ansys-workbench-core/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-workbench-core.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-workbench-core
+   :alt: PyPI
+
+.. |GH-CI| image:: https://github.com/ansys/pyworkbench/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/ansys/pyworkbench/actions/workflows/ci.yml
+   :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/blog/license/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
+
+PyWorkbench is a Python client library for Ansys Workbench.
+
+Installation
+------------
+
+To install PyWorkbench in user mode, use `pip <https://pypi.org/project/pip/>`_ :
+
+.. code-block:: bash
+
+    pip install ansys-workbench-core
+
+To install the latest development version of PyWorkbench, use the following commands:
+
+.. code-block:: bash
+
+    git clone https://github.com/ansys/pyworkbench
+    cd pyworkbench
+    pip install -e .
+
+For more information, see `Getting started <https://workbench.docs.pyansys.com/version/dev/getting-started.html>`_
+in the PyWorkbench documentation.
+
+Documentation and issues
+------------------------
+
+Documentation of the latest stable release of PyWorkbench can be found at
+`PyWorkbench documentation <https://workbench.docs.pyansys.com>`_.
+
+The documentation has these sections:
+
+- `Getting started <https://workbench.docs.pyansys.com/version/dev/getting-started.html>`_: Learn
+  how to install PyWorkbench and connect to Workbench.
+- `User guide <https://workbench.docs.pyansys.com/version/dev/user-guide.html>`_: Understand key
+  concepts and approaches for using PyWorkbench with the Workbench gRPC service.
+- `API reference <https://workbench.docs.pyansys.com/version/stable/api/index.html>`_: Understand
+  how to use Python to interact programmatically with PyWorkbench.
+- `Examples <https://workbench.docs.pyansys.com/version/dev/examples.html>`_: Explore examples that
+  show how to use PyWorkbench to create custom applications, automate your existing Workbench
+  workflows, and integrate with other popular tools in the Python ecosystem.
+
+In the upper right corner of the documentation's title bar, there is an option for switching from
+viewing the documentation for the
+latest stable release to viewing the documentation for the development version or previously released versions.
+
+On the `PyWorkbench Issues <https://github.com/ansys/pyworkbench/issues>`_
+page, you can create issues to report bugs and request new features. On the
+`Discussions <https://discuss.ansys.com/>`_ page on the Ansys Developer portal,
+you can post questions, share ideas, and get community feedback.
+
+If you have general questions about the PyAnsys ecosystem, email
+`pyansys.core@ansys.com <pyansys.core@ansys.com>`_. If your
+question is specific to PyWorkbench, ask your
+question in an issue as described in the previous paragraph.
+

ansys_workbench_core-0.4.0/README.rst

@@ -0,0 +1,82 @@
+PyWorkbench
+===========
+
+|pyansys| |python| |pypi| |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-workbench-core?logo=pypi
+   :target: https://pypi.org/project/ansys-workbench-core/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-workbench-core.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-workbench-core
+   :alt: PyPI
+
+.. |GH-CI| image:: https://github.com/ansys/pyworkbench/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/ansys/pyworkbench/actions/workflows/ci.yml
+   :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/blog/license/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
+
+PyWorkbench is a Python client library for Ansys Workbench.
+
+Installation
+------------
+
+To install PyWorkbench in user mode, use `pip <https://pypi.org/project/pip/>`_ :
+
+.. code-block:: bash
+
+    pip install ansys-workbench-core
+
+To install the latest development version of PyWorkbench, use the following commands:
+
+.. code-block:: bash
+
+    git clone https://github.com/ansys/pyworkbench
+    cd pyworkbench
+    pip install -e .
+
+For more information, see `Getting started <https://workbench.docs.pyansys.com/version/dev/getting-started.html>`_
+in the PyWorkbench documentation.
+
+Documentation and issues
+------------------------
+
+Documentation of the latest stable release of PyWorkbench can be found at
+`PyWorkbench documentation <https://workbench.docs.pyansys.com>`_.
+
+The documentation has these sections:
+
+- `Getting started <https://workbench.docs.pyansys.com/version/dev/getting-started.html>`_: Learn
+  how to install PyWorkbench and connect to Workbench.
+- `User guide <https://workbench.docs.pyansys.com/version/dev/user-guide.html>`_: Understand key
+  concepts and approaches for using PyWorkbench with the Workbench gRPC service.
+- `API reference <https://workbench.docs.pyansys.com/version/stable/api/index.html>`_: Understand
+  how to use Python to interact programmatically with PyWorkbench.
+- `Examples <https://workbench.docs.pyansys.com/version/dev/examples.html>`_: Explore examples that
+  show how to use PyWorkbench to create custom applications, automate your existing Workbench
+  workflows, and integrate with other popular tools in the Python ecosystem.
+
+In the upper right corner of the documentation's title bar, there is an option for switching from
+viewing the documentation for the
+latest stable release to viewing the documentation for the development version or previously released versions.
+
+On the `PyWorkbench Issues <https://github.com/ansys/pyworkbench/issues>`_
+page, you can create issues to report bugs and request new features. On the
+`Discussions <https://discuss.ansys.com/>`_ page on the Ansys Developer portal,
+you can post questions, share ideas, and get community feedback.
+
+If you have general questions about the PyAnsys ecosystem, email
+`pyansys.core@ansys.com <pyansys.core@ansys.com>`_. If your
+question is specific to PyWorkbench, ask your
+question in an issue as described in the previous paragraph.

ansys_workbench_core-0.4.0/pyproject.toml

@@ -0,0 +1,136 @@
+[build-system]
+requires = ["flit_core >=3.4,<4"]
+build-backend = "flit_core.buildapi"
+
+# Check https://flit.pypa.io/en/latest/pyproject_toml.html about this config file
+
+[project]
+name = "ansys-workbench-core"
+version = "0.4.0"
+description = "A python wrapper for Ansys Workbench"
+readme = "README.rst"
+requires-python = ">=3.9,<4.0"
+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",
+    'Topic :: Scientific/Engineering',
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = [
+    "ansys_api_workbench>=0.2.0",
+    "ansys-platform-instancemanagement>=1.0.1",
+    "ansys-pythonnet>=3.1.0rc1",
+    "ansys-tools-path>=0.3.1",
+    "tqdm>=4.65.0",
+    "WMI>=1.4.9",
+]
+[project.optional-dependencies]
+doc = [
+    "ansys-sphinx-theme[autoapi]==0.16.5",
+    "numpydoc==1.7.0",
+    "Sphinx==7.3.7",
+    "sphinx-autodoc-typehints==2.1.1",
+    "sphinx-copybutton==0.5.2",
+]
+vulnerabilities = [
+    "bandit==1.7.8",
+    "safety==3.2.3",
+]
+tests = [
+    "pytest==8.2.2",
+    "pytest-cov==5.0.0",
+]
+
+[project.urls]
+Documentation = "https://workbench.docs.pyansys.com"
+Source = "https://github.com/ansys/pyworkbench"
+Homepage = "https://github.com/ansys/pyworkbench"
+Tracker = "https://github.com/ansys/pyworkbench/issues"
+
+[tool.flit.module]
+name = "ansys.workbench.core"
+
+[tool.coverage.run]
+source = ["ansys.workbench"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.pytest.ini_options]
+minversion = "7.1"
+addopts = "-ra --cov=ansys.workbench --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+extend-exclude = [
+    "examples/**/*.py", "tests/scripts/*.py"
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle, see https://beta.ruff.rs/docs/rules/#pycodestyle-e-w
+    "D",    # pydocstyle, see https://beta.ruff.rs/docs/rules/#pydocstyle-d
+    "F",    # pyflakes, see https://beta.ruff.rs/docs/rules/#pyflakes-f
+    "I",    # isort, see https://beta.ruff.rs/docs/rules/#isort-i
+    "N",    # pep8-naming, see https://beta.ruff.rs/docs/rules/#pep8-naming-n
+    #"PTH",  # flake8-use-pathlib, https://beta.ruff.rs/docs/rules/#flake8-use-pathlib-pth
+]
+
+#[tool.ruff.lint.extend-per-file-ignores]
+#"tests/*" = ["D100", "D101", "D102", "D103", "PTH"] # ignore docstring requirements in tests
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.isort]
+# Settings: https://docs.astral.sh/ruff/settings/#lintisort
+combine-as-imports = true
+force-sort-within-sections = true
+known-first-party = ["ansys"]
+
+[tool.towncrier]
+directory = "doc/changelog.d"
+filename = "doc/source/changelog.rst"
+template = "doc/changelog.d/changelog_template.jinja"
+start_string = ".. towncrier release notes start\n"
+title_format = "`{version} <https://github.com/ansys/pyworkbench/releases/tag/v{version}>`_ - {project_date}"
+issue_format = "`#{issue} <https://github.com/ansys/pyworkbench/pull/{issue}>`_"
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "dependencies"
+name = "Dependencies"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "miscellaneous"
+name = "Miscellaneous"
+showcontent = true

ansys_workbench_core-0.4.0/src/ansys/workbench/core/__init__.py

@@ -0,0 +1,32 @@
+# Copyright (C) 2023 - 2024 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.
+
+"""PyWorkbench client in Python: ansys-workbench-core."""
+
+import importlib.metadata as importlib_metadata
+
+# exposed API
+from ansys.workbench.core.public_api import connect_workbench, launch_workbench  # noqa: F401
+
+# Read from the pyproject.toml
+__version__ = importlib_metadata.version("ansys-workbench-core")
+"""Version of ansys-workbench-core module."""

ansys_workbench_core-0.4.0/src/ansys/workbench/core/example_data.py

@@ -0,0 +1,97 @@
+# Copyright (C) 2023 - 2024 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.
+
+"""Module for downloading example data from the ``example-data`` repository."""
+
+import logging
+import os
+import shutil
+import urllib.request
+
+
+class ExampleData:
+    """Provides for downloading example data from the ``example-data`` repository."""
+
+    def _get_file_url(relative_file_path):  # noqa: N805
+        """Get the URL of the file in the ``example-data`` repository.
+
+        Parameters
+        ----------
+        filename : str
+            Name of the file.
+        dirname : str
+            Name of the directory containing the file.
+
+        Returns
+        -------
+        str
+            URL of the file in the ``example-data`` repository.
+        """
+        return f"https://github.com/ansys/example-data/tree/master/pyworkbench/{relative_file_path}"
+
+    def __retrieve_file(url, local_file_path):  # noqa: N805
+        """Download the file from the URL.
+
+        Parameters
+        ----------
+        url : str
+            URL of the file.
+        local_file_path : str
+            Local path to save the file to.
+
+        Raises
+        ------
+        Exception
+            If the URL is not accessible.
+        """
+        logging.info(f"Downloading {url} from ``example-data`` repository ...")
+
+        with urllib.request.urlopen(url) as in_stream:
+            if in_stream.code != 200:
+                raise Exception("error getting the url, code " + str(in_stream.code))
+            with open(local_file_path, "wb") as out_file:
+                shutil.copyfileobj(in_stream, out_file)
+        logging.info(f"Downloaded the file as {local_file_path}.")
+
+    def download(relative_file_path, local_dir_path):  # noqa: N805
+        """Download the file from the ``example-data`` repository.
+
+        Parameters
+        ----------
+        relative_file_path : str
+            File path relative to the ``pyworkbench`` folder in the ``example-data`` repository.
+        local_dir_path : str
+           Local path to the directory to save the file to.
+
+        Returns
+        -------
+        str
+            Name of the downloaded file.
+        """
+        url = ExampleData._get_file_url(relative_file_path)
+        downloaded_file_name = os.path.basename(relative_file_path)
+        local_file_path = os.path.join(local_dir_path, downloaded_file_name)
+        ExampleData.__retrieve_file(url, local_file_path)
+        return downloaded_file_name
+
+
+__all__ = []

ansys_workbench_core-0.4.0/src/ansys/workbench/core/public_api.py

@@ -0,0 +1,329 @@
+# Copyright (C) 2023 - 2024 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.
+
+"""Module for launching a Workbench server on a local or remote Windows machine."""
+
+import logging
+import os
+import platform
+import tempfile
+import time
+import uuid
+
+try:
+    if platform.system() == "Windows":
+        import wmi
+except ImportError:
+    # Handle the case when 'wmi' cannot be imported
+    wmi = None
+
+from ansys.workbench.core.workbench_client import WorkbenchClient
+
+
+class ClientWrapper(WorkbenchClient):
+    """Provides for connecting to a Workbench server.
+
+    Parameters
+    ----------
+    port : int
+        Port used by the server.
+    client_workdir : str, default: None
+        Path to a writable directory on the client computer.
+    host : str, default: None
+        Server computer's name or IP address.
+    """
+
+    def __init__(self, port, client_workdir=None, host=None):
+        """Create a PyWorkbench client that connects to a Workbench server."""
+        if host is None:
+            host = "localhost"
+        if client_workdir is None:
+            client_workdir = tempfile.gettempdir()
+        super().__init__(client_workdir, host, port)
+        super()._connect()
+
+    def exit(self):
+        """Disconnect from the server."""
+        if super()._is_connected():
+            super()._disconnect()
+
+
+class LaunchWorkbench(ClientWrapper):
+    """Launch a Workbench server on a local or remote Windows machine.
+
+    Parameters
+    ----------
+    release : str, default: "242"
+        Workbench release to launch.
+    client_workdir : str, default: None
+        Path to a writable directory on the client computer. The default is ``None``,
+        in which case the system temp directory is used.
+    server_workdir : str, None
+        Path to a writable directory on the server computer. The default is ``None``,
+        in which case the user preference for the Workbench temporary file folder is used.
+    host : str, None
+        Server computer's name or IP address. The default is ``None`` for launching on the
+        local computer.
+    username : str, None
+        User's login name on the server computer. The default is ``None`` for launching on
+        the local computer.
+    password : str, None
+        User's password on the server computer. The default is ``None`` for launching on
+        the local computer.
+
+    Raises
+    ------
+    Exception
+        If the Ansys release number is invalid.
+
+    Examples
+    --------
+    Launch a server on the local computer and use the ``wb`` variable to hold the returned client.
+
+    >>> from ansys.workbench.core import launch_workbench
+    >>> wb = launch_workbench()
+    """
+
+    def __init__(
+        self,
+        release="242",
+        client_workdir=None,
+        server_workdir=None,
+        host=None,
+        username=None,
+        password=None,
+    ):
+        self._wmi_connection = None
+        self._process_id = -1
+
+        if (
+            len(release) != 3
+            or not release.isdigit()
+            or release[0] not in ["2", "3"]
+            or release[2] not in ["1", "2"]
+        ):
+            raise Exception("Invalid ANSYS release: " + release)
+        port = self.__launch_server(host, release, server_workdir, username, password)
+        if port is None or port <= 0:
+            raise Exception("Filed to launch Ansys Workbench service.")
+        super().__init__(port, client_workdir, host)
+
+    def __launch_server(self, host, release, server_workdir, username, password):
+        """Launch a Workbench server on the local or a remote Windows machine."""
+        try:
+            if host is None:
+                self._wmi_connection = wmi.WMI()
+            else:
+                if username is None or password is None:
+                    raise Exception(
+                        "Username and passwork must be specified "
+                        "to launch Workbench on a remote machine."
+                    )
+                self._wmi_connection = wmi.WMI(host, user=username, password=password)
+            logging.info("Host connection is established.")
+
+            install_path = None
+            for ev in self._wmi_connection.Win32_Environment():
+                if ev.Name == "AWP_ROOT" + release:
+                    install_path = ev.VariableValue
+                    break
+            if install_path is None:
+                install_path = "C:/Program Files/Ansys Inc/v" + release
+                logging.warning(
+                    "Ansys installation is not found. Assume the default location: " + install_path
+                )
+            else:
+                logging.info("Ansys installation is found at: " + install_path)
+            executable = os.path.join(install_path, "Framework", "bin", "Win64", "RunWB2.exe")
+            prefix = uuid.uuid4().hex
+            workdir_arg = ""
+            if server_workdir is not None:
+                # use forward slash only to avoid escaping as command line argument
+                server_workdir = server_workdir.replace("\\", "/")
+                workdir_arg = ",WorkingDirectory='" + server_workdir + "'"
+            command = (
+                executable
+                + " -I -E \"StartServer(EnvironmentPrefix='"
+                + prefix
+                + "'"
+                + workdir_arg
+                + ')"'
+            )
+
+            process_startup_info = self._wmi_connection.Win32_ProcessStartup.new(ShowWindow=1)
+            process_id, result = self._wmi_connection.Win32_Process.Create(
+                CommandLine=command, ProcessStartupInformation=process_startup_info
+            )
+
+            if result == 0:
+                logging.info("Workbench launched on the host with process id: " + str(process_id))
+                self._process_id = process_id
+            else:
+                logging.error("Workbench failed to launch on the host.")
+                return 0
+
+            # retrieve server port once WB is fully up running
+            port = None
+            timeout = 60 * 8  # set 8 minutes as upper limit for WB startup
+            start_time = time.time()
+            while True:
+                for ev in self._wmi_connection.Win32_Environment():
+                    if ev.Name == "ANSYS_FRAMEWORK_SERVER_PORT":
+                        port = ev.VariableValue
+                        if port.startswith(prefix):
+                            port = port[len(prefix) :]
+                            break
+                        else:
+                            port = None
+                        break
+                if port is not None:
+                    break
+                if time.time() - start_time > timeout:
+                    logging.error("Failed to start Workbench service within reasonable timeout.")
+                    break
+                time.sleep(10)
+            if port is None:
+                logging.error("Failed to retrieve the port used by Workbench service.")
+            else:
+                logging.info("Workbench service uses port " + port)
+
+            return int(port)
+
+        except wmi.x_wmi:
+            logging.error("wrong credential")
+
+    def exit(self):
+        """Terminate the Workbench server and disconnect the client."""
+        super().exit()
+
+        if self._wmi_connection is None:
+            return
+
+        # collect parent-children mapping
+        children = {self._process_id: []}
+        process_by_id = {}
+        for p in self._wmi_connection.Win32_Process():
+            process_by_id[p.ProcessId] = p
+            children.setdefault(p.ProcessId, [])
+            if p.ParentProcessId is None:
+                continue
+            children.setdefault(p.ParentProcessId, [])
+            children[p.ParentProcessId].append(p.ProcessId)
+
+        # terminate related processes bottom-up
+        to_terminate = []
+        this_level = set([self._process_id])
+        while True:
+            next_level = set()
+            for p in this_level:
+                next_level.update(children[p])
+            if len(next_level) == 0:
+                break
+            to_terminate.append(next_level)
+            this_level = next_level
+        for ps in reversed(to_terminate):
+            for p in ps:
+                logging.info("Shutting down " + process_by_id[p].Name + " ...")
+                try:
+                    process_by_id[p].Terminate()
+                except Exception:
+                    pass
+
+        logging.info("Workbench server connection has ended.")
+        self._wmi_connection = None
+        self._process_id = -1
+
+
+def launch_workbench(
+    release="242", client_workdir=None, server_workdir=None, host=None, username=None, password=None
+):
+    """Launch PyWorkbench server on the local or a remote Windows machine.
+
+    This method launch a Workbench server on the local or a remote Windows machine and creates
+    a PyWorkbench client that connects to the server.
+
+    Parameters
+    ----------
+    release : str, default: "242"
+        Workbench release to launch.
+    client_workdir : str, default: None
+        Path to a writable directory on the client computer. The default is ``None``,
+        in which case the system temp directory is used.
+    server_workdir : str, None
+        Path to a writable directory on the server computer. The default is ``None``,
+        in which case the user preference for the Workbench temporary file folder is used.
+    host : str, None
+        Server computer's name or IP address. The default is ``None`` for launching on the
+        local computer.
+    username : str, None
+        User's login name on the server computer. The default is ``None`` for launching on
+        the local computer.
+    password : str, None
+        User's password on the server computer. The default is ``None`` for launching on
+        the local computer.
+
+    Returns
+    -------
+    ClientWrapper
+        Instance of the PyWorkbench client that is connected to the launched server.
+
+    Examples
+    --------
+    Launch a server on the local computer and use the ``wb`` variable to hold the returned client.
+
+    >>> from ansys.workbench.core import launch_workbench
+    >>> wb = launch_workbench()
+
+    """
+    return LaunchWorkbench(release, client_workdir, server_workdir, host, username, password)
+
+
+def connect_workbench(port, client_workdir=None, host=None):
+    """Create a PyWorkbench client that connects to an already running Workbench server.
+
+    Parameters
+    ----------
+    port : int
+        Port used by the server.
+    client_workdir : str, default: None
+        Path to a writable directory on the client computer. The default is ``None``,
+        in which case the system temp directory is used.
+    host : str, default: None
+        Server computer's name or IP address. The default is ``None`` for the local computer.
+
+    Returns
+    -------
+    ClientWrapper
+        Instance of the PyWorkbench client that is connected to the server.
+
+    Examples
+    --------
+    Connect to a server at port 32588 on localhost and use the ``wb`` variable to hold the
+    returned client.
+
+    >>> from ansys.workbench.core import connect_workbench
+    >>> wb = connect_workbench(port = 32588)
+    """
+    return ClientWrapper(port, client_workdir, host)
+
+
+__all__ = ["launch_workbench", "connect_workbench"]

ansys_workbench_core-0.4.0/src/ansys/workbench/core/workbench_client.py

@@ -0,0 +1,528 @@
+# Copyright (C) 2023 - 2024 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.
+
+"""Workbench client module for PyWorkbench."""
+
+import glob
+import json
+import logging
+import logging.handlers
+from logging.handlers import WatchedFileHandler
+import os
+
+import grpc
+import tqdm
+
+from ansys.api.workbench.v0 import workbench_pb2 as wb
+from ansys.api.workbench.v0.workbench_pb2_grpc import WorkbenchServiceStub
+from ansys.workbench.core.example_data import ExampleData
+
+
+class WorkbenchClient:
+    """Provides the PyWorkbench client.
+
+    Parameters
+    ----------
+    local_workdir : str
+        Local working directory for the client.
+    server_host : str
+        Hostname or IP address of the server.
+    server_port : int
+        Port number of the server.
+    """
+
+    def __init__(self, local_workdir, server_host, server_port):
+        """Create a Workbench client."""
+        self.workdir = local_workdir
+        self._server_host = server_host
+        self._server_port = server_port
+        self.__init_logging()
+
+    def __enter__(self):
+        """Connect to the server when entering a context."""
+        self._connect()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        """Disconnect from the server when exiting a context."""
+        self._disconnect()
+
+    def _connect(self):
+        """Connect to the server."""
+        hnp = self._server_host + ":" + str(self._server_port)
+        self.channel = grpc.insecure_channel(hnp)
+        self.stub = WorkbenchServiceStub(self.channel)
+        logging.info("connected to the WB server at " + hnp)
+
+    def _disconnect(self):
+        """Disconnect from the server."""
+        if self.channel:
+            self.channel.close()
+            self.channel = None
+            self.stub = None
+            logging.info("Disconnected from the Workbench server")
+
+    def _is_connected(self):
+        """Return whether this client is connected to the server."""
+        return self.channel is not None
+
+    def __init_logging(self):
+        """Initialize logging for the client."""
+        self._logger = logging.getLogger("WB")
+        self._logger.setLevel(logging.DEBUG)
+        self._logger.propagate = False
+        stream_handler = logging.StreamHandler()
+        stream_handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
+        stream_handler.setLevel(logging.WARNING)
+        self._logger.addHandler(stream_handler)
+        self.__log_console_handler = stream_handler
+
+    def set_console_log_level(self, log_level):
+        """Set the log filter level for the client console.
+
+        Parameters
+        ----------
+        log_level : str, default: "error"
+            Level of logging. Options are "critical" "debug", "error", "info", and "warning".
+        """
+        self.__log_console_handler.setLevel(WorkbenchClient.__to_python_log_level(log_level))
+
+    def set_log_file(self, log_file):
+        """Set a local log file for the Workbench server log.
+
+        Create a locl log file if one does not exist and append it to the existing log file.
+
+        Parameters
+        ----------
+        log_file : str
+            Path to a local file to use for logging.
+        """
+        self.reset_log_file()
+
+        file_handler = WatchedFileHandler(log_file)
+        file_handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
+        file_handler.setLevel(logging.DEBUG)
+        self._logger.addHandler(file_handler)
+        self.__log_file_handler = file_handler
+
+    def reset_log_file(self):
+        """No longer use the current log file for the Workbench server log."""
+        if self.__log_file_handler is None:
+            return
+        self.__log_file_handler.close()
+        self._logger.removeHandler(self.__log_file_handler)
+        self.__log_file_handler = None
+
+    __log_file_handler = None
+    __log_console_handler = None
+
+    def run_script_string(self, script_string, log_level="error"):
+        """Run a script on the server.
+
+        Parameters
+        ----------
+        script_string : str
+            String containing the content of the script to run.
+        log_level : str, default: "error"
+            Level of logging. Options are "critical" "debug", "error", "info", and "warning".
+
+        Returns
+        -------
+        str
+            Output defined in the script.
+
+        Examples
+        --------
+        Run a Workbench script, given in a string, that returns the name of
+        a newly created system.
+
+        >>> wb.run_script_string(r'''import json
+        wb_script_result=json.dumps(GetTemplate(TemplateName="FLUENT").CreateSystem().Name)
+        ''')
+
+        """
+        if not self._is_connected():
+            logging.error("Workbench client is not yet connected to a server.")
+        request = wb.RunScriptRequest(
+            content=script_string, log_level=WorkbenchClient.__to_server_log_level(log_level)
+        )
+        for response in self.stub.RunScript(request):
+            if response.log and response.log.messages and len(response.log.messages) > 0:
+                for log_entry in response.log.messages:
+                    self.__python_logging(log_entry.level, log_entry.message)
+            if response.result:
+                if response.result.error:
+                    logging.error("Error when running the script: " + response.result.error)
+                    return None
+                elif response.result.result:
+                    logging.info("The script has finisished.")
+                    return json.loads(response.result.result)
+
+    def run_script_file(self, script_file_name, log_level="error"):
+        """Run a script file on the server.
+
+        Parameters
+        ----------
+        script_file_name : str
+            Name of the script file to run. The script file is located in the client
+            working directory
+        log_level : str, default: "error"
+            Level of logging. Options are "critical" "debug", "error", "info", and "warning".
+
+        Returns
+        -------
+        str
+            Output defined in the script.
+        """
+        if not self._is_connected():
+            logging.error("Workbench client is not yet connected to a server")
+        script_path = os.path.join(self.workdir, script_file_name)
+        with open(script_path, encoding="utf-8-sig") as sf:
+            script_string = sf.read()
+        return self.run_script_string(script_string, log_level)
+
+    def upload_file(self, *file_list, show_progress=True):
+        """Upload one or more files from the client to the server.
+
+        Parameters
+        ----------
+        file_list : list[str]
+            List of paths to the one or more local files to upload. The
+            wildcard characters "?" and "*" are supported.
+        show_progress : bool, default: True
+            Whether to show a progress bar during the upload.
+
+        Returns
+        -------
+        list[str]
+            Names of the uploaded file.
+        """
+        if not self._is_connected():
+            logging.error("Workbench client is not yet connected to a server.")
+        requested = []
+        for file_pattern in file_list:
+            if "*" in file_pattern or "?" in file_pattern:
+                if not os.path.isabs(file_pattern):
+                    file_pattern = os.path.join(self.workdir, file_pattern)
+                requested.extend(glob.glob(file_pattern))
+            else:
+                requested.append(file_pattern)
+        existing_files = []
+        nonexisting_files = []
+        for file_name in requested:
+            if not os.path.isabs(file_name):
+                file_name = os.path.join(self.workdir, file_name)
+            if os.path.isfile(file_name):
+                existing_files.append(file_name)
+            else:
+                nonexisting_files.append(file_name)
+        if len(nonexisting_files) > 0:
+            logging.warning(
+                "The following files do not exist and are skipped: " + "\n".join(nonexisting_files)
+            )
+        for file_path in existing_files:
+            logging.info(f"uploading file {file_path}")
+            response = self.stub.UploadFile(self.__upload_iterator(file_path, show_progress))
+            if response.error:
+                logging.error("Error during file upload: " + response.error)
+            else:
+                logging.info(
+                    "A file is uploaded to the server with the name: " + response.file_name
+                )
+
+    def __upload_iterator(self, file_path, show_progress):
+        dir_path, file_name = os.path.split(file_path)
+        yield wb.UploadFileRequest(file_name=file_name)
+
+        pbar = None
+        if show_progress:
+            bytes = os.path.getsize(file_path)
+            pbar = tqdm.tqdm(
+                total=bytes,
+                desc=f"Uploading {file_name}",
+                unit="B",
+                unit_scale=True,
+                unit_divisor=1024,
+            )
+
+        chunk_size = 65536  ## 64 kb
+        with open(file_path, mode="rb") as f:
+            while True:
+                chunk = f.read(chunk_size)
+                if chunk:
+                    if pbar is not None:
+                        pbar.update(len(chunk))
+                    yield wb.UploadFileRequest(file_content=chunk)
+                else:
+                    if pbar is not None:
+                        pbar.close()
+                    return
+
+    def upload_file_from_example_repo(self, relative_file_path, show_progress=True):
+        """Upload a file from the Ansys ``example-data`` repository to the server.
+
+        Parameters
+        ----------
+        relative_file_path : str
+            File path relative to the ``pyworkbench`` folder in the ``example-data`` repository.
+        show_progress : bool, default: True
+            Whether to show a progress bar during the upload.
+        """
+        if not self._is_connected():
+            logging.error("Workbench client is not yet connected to a server.")
+        downloaded = ExampleData.download(relative_file_path, self.workdir)
+        self.upload_file(downloaded, show_progress=show_progress)
+
+    def download_file(self, file_name, show_progress=True, target_dir=None):
+        """Download one or more files from the server.
+
+        Parameters
+        ----------
+        file_name : str
+            Name of the file. File must be located in the server's working directory.
+            The wildcard characters "?" and "*" are supported. A ZIP file is automatically
+            generated and downloaded when multiple files are specified.
+        show_progress : bool, default: True
+            Whether to show a progress bar during the download.
+        target_dir : str, default: None
+            Path to a local directory to download the files to. The default is ``None``,
+            in which case the client working directory is used.
+
+
+        Returns
+        -------
+        str
+            Names of the one or more downloaded files.
+        """
+        if not self._is_connected():
+            logging.error("Workbench client is not yet connected to a server.")
+        request = wb.DownloadFileRequest(file_name=file_name)
+        file_name = file_name.replace("*", "_").replace("?", "_")
+        td = target_dir
+        if td is None:
+            td = self.workdir
+        file_path = os.path.join(td, file_name)
+        pbar = None
+        started = False
+        for response in self.stub.DownloadFile(request):
+            if response.error:
+                logging.error("Error during file download: " + response.error)
+                return None
+            if response.file_info:
+                if response.file_info.is_archive:
+                    file_name += ".zip"
+                    file_path += ".zip"
+                if response.file_info.file_size > 0:
+                    if show_progress:
+                        pbar = tqdm.tqdm(
+                            total=response.file_info.file_size,
+                            desc=f"Downloading {file_name}",
+                            unit="B",
+                            unit_scale=True,
+                            unit_divisor=1024,
+                        )
+            if response.file_content:
+                size = len(response.file_content)
+                if size > 0:
+                    if not started:
+                        if os.path.exists(file_path):
+                            os.remove(file_path)
+                        started = True
+                    with open(file_path, mode="ab") as f:
+                        f.write(response.file_content)
+                    if pbar is not None:
+                        pbar.update(size)
+        logging.info(f"Dwnloaded the file {file_name}.")
+        if pbar is not None:
+            pbar.close()
+        return file_name
+
+    def __python_logging(self, log_level, msg):
+        """Log a message with the given log level.
+
+        Parameters
+        ----------
+        log_level : int
+            log level. Options are ``logging.CRITICAL``, ``logging.DEBUG``, ``logging.ERROR``,
+            ``logging.INFO``, and ``logging.WARNING``.
+
+        msg : str
+            Message to log.
+        """
+        if log_level == wb.LOG_DEBUG:
+            self._logger.debug(msg)
+        elif log_level == wb.LOG_INFO:
+            self._logger.info(msg)
+        elif log_level == wb.LOG_WARNING:
+            self._logger.warn(msg)
+        elif log_level == wb.LOG_ERROR:
+            self._logger.error(msg)
+        elif log_level == wb.LOG_FATAL:
+            self._logger.fatal(msg)
+
+    @staticmethod
+    def __to_python_log_level(log_level):
+        """Convert the given log level to the corresponding Python log level.
+
+        Parameters
+        ----------
+        log_level : str
+            level of logging: options are "debug", "info", "warning", "error", "critical"
+
+        Returns
+        -------
+        int
+            the corresponding Python log level
+        """
+        log_level = log_level.lower()
+        for level_name, server_level in WorkbenchClient.__log_levels.items():
+            if log_level in level_name:
+                return server_level[1]
+        return logging.NOTSET
+
+    @staticmethod
+    def __to_server_log_level(log_level):
+        """Convert the given log level to the corresponding server log level.
+
+        Parameters
+        ----------
+        log_level : str
+            Level of logging. Options are "critical" "debug", "error", "info", and "warning".
+
+        Returns
+        -------
+        int
+            Corresponding server log level.
+        """
+        log_level = log_level.lower()
+        for level_name, server_level in WorkbenchClient.__log_levels.items():
+            if log_level in level_name:
+                return server_level[0]
+        return wb.LOG_NONE
+
+    __log_levels = {
+        "none null": (wb.LOG_NONE, logging.NOTSET),
+        "debug": (wb.LOG_DEBUG, logging.DEBUG),
+        "information": (wb.LOG_INFO, logging.INFO),
+        "warning": (wb.LOG_WARNING, logging.WARNING),
+        "error": (wb.LOG_ERROR, logging.ERROR),
+        "fatal critical": (wb.LOG_FATAL, logging.CRITICAL),
+    }
+
+    def start_mechanical_server(self, system_name):
+        """Start the PyMechanical server for the given system in the Workbench project.
+
+        Parameters
+        ----------
+        system_name : str
+            Name of the system in the Workbench project.
+
+        Returns
+        -------
+        int
+            Port number of the PyMechanical server used to start the PyMechanical client.
+
+        Examples
+        --------
+        Start a PyMechanical session for the given system name.
+
+        >>> from ansys.mechanical.core import launch_mechanical
+        >>> server_port=wb.start_mechanical_server(system_name=mech_system_name)
+        >>> mechanical = launch_mechanical(start_instance=False, port=server_port)
+
+        """
+        pymech_port = self.run_script_string(
+            f"""import json
+server_port=LaunchMechanicalServerOnSystem(SystemName="{system_name}")
+wb_script_result=json.dumps(server_port)
+"""
+        )
+        return pymech_port
+
+    def start_fluent_server(self, system_name):
+        """Start the PyFluent server for the given system in the Workbench project.
+
+        Parameters
+        ----------
+        system_name : str
+            Name of the system in the Workbench project.
+
+        Returns
+        -------
+        str
+            Path to the local file containing the PyFluent server information that
+            can be used to start a PyFluent client.
+
+        Examples
+        --------
+        Start a PyFluent session for the given system name.
+
+        >>> import ansys.fluent.core as pyfluent
+        >>> server_info_file=wb.start_fluent_server(system_name=fluent_sys_name)
+        >>> fluent=pyfluent.connect_to_fluent(server_info_file_name=server_info_file)
+
+        """
+        server_info_file_name = self.run_script_string(
+            f"""import json
+server_info_file=LaunchFluentServerOnSystem(SystemName="{system_name}")
+wb_script_result=json.dumps(server_info_file)
+"""
+        )
+        local_copy = os.path.join(self.workdir, server_info_file_name)
+        if os.path.exists(local_copy):
+            os.remove(local_copy)
+        self.download_file(server_info_file_name, show_progress=False)
+        return local_copy
+
+    def start_sherlock_server(self, system_name):
+        """Start the PySherlock server for the given system in the Workbench project.
+
+        Parameters
+        ----------
+        system_name : str
+            Name of the system in the Workbench project.
+
+        Returns
+        -------
+        int
+            Prt number of the PySherlock server used to start a PySherlock client.
+
+        Examples
+        --------
+        Start a PySherlock session for the given system name.
+
+        >>> from ansys.sherlock.core import pysherlock
+        >>> server_port=wb.start_sherlock_server(system_name=sherlock_system_name)
+        >>> sherlock = pysherlock.connect_grpc_channel(port=server_port)
+        >>> sherlock.common.check()
+
+        """
+        pysherlock_port = self.run_script_string(
+            f"""import json
+server_port=LaunchSherlockServerOnSystem(SystemName="{system_name}")
+wb_script_result=json.dumps(server_port)
+"""
+        )
+        return pysherlock_port
+
+
+__all__ = ["WorkbenchClient"]