ansys-pyensight-core 0.11.0__py3-none-any.whl

ansys_pyensight_core-0.11.0.dist-info/METADATA

@@ -0,0 +1,309 @@
+Metadata-Version: 2.4
+Name: ansys-pyensight-core
+Version: 0.11.0
+Summary: A python wrapper for Ansys EnSight
+Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Requires-Python: >=3.10,<3.14
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+License-File: LICENSE
+Requires-Dist: importlib-metadata>=4.0; python_version<='3.8'
+Requires-Dist: ansys-api-pyensight==0.4.9
+Requires-Dist: requests>=2.28.2
+Requires-Dist: docker>=6.1.0
+Requires-Dist: urllib3<3
+Requires-Dist: numpy>=1.21.0,<3
+Requires-Dist: Pillow>=9.3.0
+Requires-Dist: pypng>=0.0.20
+Requires-Dist: psutil>=5.9.2
+Requires-Dist: usd-core==25.11; platform_machine != 'aarch64'
+Requires-Dist: pygltflib>=1.16.2
+Requires-Dist: grpcio<1.68.0
+Requires-Dist: ansys-tools-common>=0.3.0
+Requires-Dist: build>=0.10.0 ; extra == "dev"
+Requires-Dist: bump2version>=1.0.1 ; extra == "dev"
+Requires-Dist: ipdb>=0.9.4 ; extra == "dev"
+Requires-Dist: dill>=0.3.5.1 ; extra == "dev"
+Requires-Dist: pre-commit>=3.3.3 ; extra == "dev"
+Requires-Dist: Sphinx==8.1.3 ; extra == "doc"
+Requires-Dist: numpydoc==1.10.0 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme==1.6.3 ; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.20.0 ; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid==1.2.3 ; extra == "doc"
+Requires-Dist: docker>=6.1.0 ; extra == "doc"
+Requires-Dist: matplotlib==3.10.1 ; extra == "doc"
+Requires-Dist: requests>=2.28.2 ; extra == "doc"
+Requires-Dist: sphinxcontrib.jquery==4.1 ; extra == "doc"
+Requires-Dist: sphinxcontrib-openapi==0.8.4 ; extra == "doc"
+Requires-Dist: coverage-badge==1.1.2 ; extra == "doc"
+Requires-Dist: sphinxcontrib-video==0.4.1 ; extra == "doc"
+Requires-Dist: usd-core>=25.8 ; extra == "doc"
+Requires-Dist: pygltflib>=1.16.2 ; extra == "doc"
+Requires-Dist: pytest==9.0.1 ; extra == "tests"
+Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
+Requires-Dist: dill>=0.3.5.1 ; extra == "tests"
+Requires-Dist: pytest-mock==3.15.1 ; extra == "tests"
+Requires-Dist: urllib3<3.0.0 ; extra == "tests"
+Requires-Dist: requests>=2.28.2 ; extra == "tests"
+Requires-Dist: docker>=6.1.0 ; extra == "tests"
+Requires-Dist: pytest-xdist==3.8.0 ; extra == "tests"
+Requires-Dist: pytest-rerunfailures>=14,<17 ; extra == "tests"
+Project-URL: Changelog, https://github.com/ansys/pyensight/blob/main/CHANGELOG.rst
+Project-URL: Documentation, https://ensight.docs.pyansys.com/
+Project-URL: Homepage, https://github.com/ansys/pyensight
+Project-URL: Source, https://github.com/ansys/pyensight
+Project-URL: Tracker, https://github.com/ansys/pyensight/issues
+Provides-Extra: dev
+Provides-Extra: doc
+Provides-Extra: tests
+
+PyEnSight
+=========
+|pyansys| |pypi| |python| |ci| |MIT| |pre-commit| |black| |isort| |bandit|
+
+.. |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/
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-pyensight-core.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-pyensight-core
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-pyensight-core?logo=pypi
+   :target: https://pypi.org/project/ansys-pyensight-core
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+
+.. |black| image:: https://img.shields.io/badge/code_style-black-000000.svg
+   :target: https://github.com/psf/black
+
+.. |isort| image:: https://img.shields.io/badge/imports-isort-%231674b1.svg?style=flat&labelColor=ef8336
+   :target: https://pycqa.github.io/isort/
+
+.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
+   :target: https://github.com/pre-commit/pre-commit
+
+.. |bandit| image:: https://img.shields.io/badge/security-bandit-yellow.svg
+    :target: https://github.com/PyCQA/bandit
+    :alt: Security Status
+
+.. |ci| image:: https://github.com/ansys/pyensight/actions/workflows/ci_cd.yml/badge.svg?branch=main
+   :target: https://github.com/ansys/pyensight/actions?query=branch%3Amain
+
+.. |title| image:: https://s3.amazonaws.com/www3.ensight.com/build/media/pyensight_title.png
+
+.. _EnSight: https://www.ansys.com/products/fluids/ansys-ensight
+
+
+Overview
+--------
+PyEnSight is a Python wrapper for EnSight_, the Ansys simulation postprocessor.
+It supports Pythonic access to EnSight so that you communicate directly with it
+from Python. With PyEnSight, you can perform these essential actions:
+
+* Start a new EnSight session or connect to an existing one.
+* Read simulation data from any supported solver output format into the session.
+* Generate complex postprocessing results in a Pythonic fashion.
+* Visualize the processed data, extract it, or get a widget to embed it in an external app.
+
+Documentation and Issues
+------------------------
+Documentation for the latest stable release of PyEnSight is hosted at
+`PyEnSight documentation <https://ensight.docs.pyansys.com/version/stable/>`_.
+
+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.
+
+You can also `view <https://cheatsheets.docs.pyansys.com/pyensight_cheat_sheet.png>`_ or
+`download <https://cheatsheets.docs.pyansys.com/pyensight_cheat_sheet.pdf>`_ the
+PyEnSight cheat sheet. This one-page reference provides syntax rules and commands
+for using PyEnSight.
+
+On the `PyEnSight Issues <https://github.com/ansys/pyensight/issues>`_ page, you can
+create issues to report bugs and request new features. On the
+`PyEnSight Discussions <https://github.com/ansys/pyensight/discussions>`_ page or the
+`Discussions <https://discuss.ansys.com/>`_ page on the Ansys Developer portal,
+you can post questions, share ideas, and get community feedback.
+
+To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
+
+Installation
+------------
+To use PyEnSight, you must have a locally installed and licensed copy of
+Ansys EnSight 2022 R2 or later. The ``ansys-pyensight-core`` package supports
+Python 3.10 through Python 3.12 on Windows and Linux.
+
+Two modes of installation are available:
+
+- User installation
+- Developer installation
+
+User installation
+~~~~~~~~~~~~~~~~~
+Install the latest release from `PyPI <https://pypi.org/project/ansys-pyensight-core/>`_
+with this command:
+
+.. code::
+
+   pip install ansys-pyensight-core
+
+
+Developer installation
+~~~~~~~~~~~~~~~~~~~~~~
+If you plan on doing local *development* of PyEnSight with GitHub, consider
+using a `virtual environment <https://docs.python.org/3/library/venv.html>`_.
+
+To clone PyEnSight and then install it in a virtual environment, run these
+commands:
+
+.. code::
+
+   git clone https://github.com/ansys/pyensight
+   cd pyensight
+   pip install virtualenv
+   virtualenv venv  # create virtual environment
+   source venv/bin/activate  # (.\venv\Scripts\activate for Windows shell)
+   pip install .[dev]   # install development dependencies
+
+A developer installation allows you to edit ``ansys-pyensight`` files locally.
+Any changes that you make are reflected in your setup after restarting the
+Python kernel.
+
+To build and install PyEnSight, run these commands:
+
+.. code::
+
+   python -m build   # build
+   # this will replace the editable install done previously. If you don't want to replace,
+   # switch your virtual environments to test the new install separately.
+   pip install .[tests]   # install test dependencies
+   pytest  # Run the tests
+
+Pre-commit setup
+----------------
+
+``pre-commit`` is a multi-language package manager for pre-commit hooks.
+
+
+To install pre-commit into your git hooks, run this command:
+
+.. code::
+
+   pre-commit install
+
+``pre-commit`` then runs on every commit. Each time you clone a project,
+installing ``pre-commit`` should always be the first action that you take.
+
+If you want to manually run all pre-commit hooks on a repository, run this
+command:
+
+.. code::
+
+   pre-commit run --all-files
+
+A bunch of formatters run on your source files.
+
+To run individual hooks, use this command, where ``<hook_id>`` is obtained from
+from the ``.pre-commit-config.yaml`` file:
+
+.. code::
+
+   pre-commit run <hook_id>
+
+The first time pre-commit runs on a file, it automatically downloads, installs,
+and runs the hook.
+
+
+Local GitHub actions
+--------------------
+Simulating GitHub Actions on your local desktop is recommended. After installing the
+`act <https://github.com/nektos/act#readme>`_ package, you can run a job. For
+example, this command runs the ``docs`` job defined in the ``ci_cd.yml`` file:
+
+.. code::
+
+   act -j docs
+
+Deploy and upload steps **must always** be ignored. If they are not ignored, before
+running a job, add ``if: ${{ !env.ACT }}`` to the workflow step (and commit if required).
+
+Usage
+-----
+You can use this code to start the simplest PyEnSight session:
+
+.. code:: python
+
+   >>> from ansys.pyensight.core import LocalLauncher
+   >>> session = LocalLauncher().start()
+   >>> data = session.render(1920, 1080, aa=4)
+   >>> with open("image.png", "wb") as f:
+   ...    f.write(data)
+
+
+Optionally, EnSight can work with an EnSight Docker container using code like this:
+
+.. code:: python
+
+   >>> from ansys.pyensight.core import DockerLauncher
+   >>> launcher = DockerLauncher(data_directory="d:/data", use_dev=True)
+   >>> launcher.pull()
+   >>> session = launcher.start()
+   >>> data = session.render(1920, 1080, aa=4)
+   >>> with open("image.png", "wb") as f:
+   ...    f.write(data)
+
+
+In the preceding code, the ``data_directory`` argument specifies the host directory
+to map into the container at the mount point, providing access to the data within
+the container. This provides a method for EnSight running in the container to access
+the host's file system to read or write data. The optional ``use_dev=True`` argument
+specifies that the latest development version of EnSight should be used.
+
+Also, PyEnSight can be launched as other PyAnsys products with the ``launch_ensight`` method:
+
+.. code:: python
+
+   >>> from ansys.pyensight.core import launch_ensight
+   >>> session = launch_ensight(use_sos=3)
+   >>> data = session.render(1920, 1080, aa=4)
+   >>> with open("image.png", "wb") as f:
+   ...    f.write(data)
+
+
+Dependencies
+------------
+You will need a locally installed and licensed copy of Ansys to run EnSight, with the
+first supported version being Ansys 2022 R2.
+
+
+Documentation and Issues
+------------------------
+Please see the latest release `documentation <https://ensight.docs.pyansys.com/>`_
+page for more details.
+
+Please feel free to post issues and other questions at `PyEnSight Issues
+<https://github.com/ansys/pyensight/issues>`_. This is the best place
+to post questions and code.
+
+License
+-------
+PyEnSight is licensed under the MIT license.
+
+PyEnsight makes no commercial claim over Ansys whatsoever. This library extends the functionality
+of Ansys EnSight by adding a remote Python interface to EnSight without changing the core behavior
+or license of the original software. The use of interactive control of PyEnSight requires a
+legally licensed local copy of Ansys.
+
+For more information on EnSight, see the `Ansys Ensight <https://www.ansys.com/products/fluids/ansys-ensight>`_
+page on the Ansys website.
+

ansys_pyensight_core-0.11.0.dist-info/RECORD

@@ -0,0 +1,37 @@
+ansys/pyensight/core/__init__.py,sha256=6fo_ycTlEiX5Z0-Sg4GbUDQN7S7Ah_7tqyv-_jB8FN0,1999
+ansys/pyensight/core/common.py,sha256=-UzeohMEg4Vy9L_eH65xgKoC1SeRdD19mVJUHla4d2c,12626
+ansys/pyensight/core/deep_pixel_view.html,sha256=6u4mGOuzJiPze8N8pIKJsEGPv5y6-zb38m9IfrarATE,3510
+ansys/pyensight/core/dockerlauncher.py,sha256=WFEYe7xvC1pG_MfoYOxUplK13PEOwAXalRN2MFaiKIc,45590
+ansys/pyensight/core/dvs.py,sha256=7VPgQqd89TLTJldbhNxk1u6ldwyhc5RKuqMlFQIudeM,35927
+ansys/pyensight/core/enscontext.py,sha256=MK9y2nq--MJwbaeVjxU_P7WIanAFsBIhhefzoY-_5_c,13295
+ansys/pyensight/core/enshell_grpc.py,sha256=XnQJsLYaNc0rAh9fH_epmQCfAJRbj4swE1Si08Z_kP8,24777
+ansys/pyensight/core/ensight_grpc.py,sha256=l6Ml1GXzlM0hGRcIomJVtN_9JUO2a57pcy0eVvdk_2Y,35470
+ansys/pyensight/core/ensobj.py,sha256=3Et3v_MNJCIPT0-xO4kd1fI0I_SXpdWaeRuHl6-fFnc,19712
+ansys/pyensight/core/launch_ensight.py,sha256=14YHJ5uA6DTBLPUV81RPTjjFM9wThH0_KYeypkJkl1w,11408
+ansys/pyensight/core/launcher.py,sha256=NlDmN-s0av1jiW7rFYgoY7UXTFW0x8y2fYm3uQIUDDM,15438
+ansys/pyensight/core/libuserd.py,sha256=Z1Hb8fAhoTxkTJ9teK7A8STsfssttDeAYGZ8nYDa57Q,77174
+ansys/pyensight/core/listobj.py,sha256=CZ3qPVJYU8qfStSw1w0XmE19f_MgyM4xwZw0TJ1ZL3A,10489
+ansys/pyensight/core/locallauncher.py,sha256=fHaEQlfEYMljhsdGAlpCENzgxc7y2JDavel6Vkem_hk,24939
+ansys/pyensight/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ansys/pyensight/core/renderable.py,sha256=cDrvzcbyx-xinVYDH1N_OGxjUVvKWB-vpcIpK2N8JJw,37516
+ansys/pyensight/core/session.py,sha256=fhl9yOrfWVyRpZHhAUl-hBYS2Z0pSQpdcchIb3qsr8o,78048
+ansys/pyensight/core/sgeo_poll.html,sha256=1M4BIc5CZpYA3b40qzk22NcPCLhjFnWdoS2PrS6Rhn4,752
+ansys/pyensight/core/utils/__init__.py,sha256=70ClrxZSR0DtoOsIgx1_vB5lbI-tWBr7Yrp1hFu7svI,1153
+ansys/pyensight/core/utils/adr.py,sha256=m7ie3FRS1R23w6kFiFjwOnrxSJtb1SIG86C3ARzJe8c,4724
+ansys/pyensight/core/utils/dsg_server.py,sha256=2ZEyq6HOTShMD9u1_oWQVjxZ2D9G3jWxMJhgfPUQXv8,49821
+ansys/pyensight/core/utils/export.py,sha256=CbpLL-0H_YH8Zimel6rZzMPpyJPtqc0WnEI4WIqUkFk,23758
+ansys/pyensight/core/utils/omniverse.py,sha256=_AeZ0lH1OqlyY5UYodQwxVHiwt9utvWb3Z_LwbKZcsA,28821
+ansys/pyensight/core/utils/omniverse_cli.py,sha256=B-za_NT7tELjlD8Gf4Yuk96h_jH-hZ5TWjR0tcK7S1c,23953
+ansys/pyensight/core/utils/omniverse_dsg_server.py,sha256=EHYypyKtBWSXMyh0qFMNE67WrrFgIhmWjEqQdT0YEBs,46141
+ansys/pyensight/core/utils/omniverse_glb_server.py,sha256=QRKia3uogYbimQk9LAE_9rt7RMfJVmcqB66Tktq2HKE,33321
+ansys/pyensight/core/utils/parts.py,sha256=Y5zzEPq9fObD-hrcJGtEktC1L0x-Udu1yKZs5SR8pdc,53327
+ansys/pyensight/core/utils/query.py,sha256=RFtcsOVlH2Y2WmTuB_DnS5rbetGNdjGFazQzrwB2gj8,20982
+ansys/pyensight/core/utils/readers.py,sha256=JzbxB80cBwAIDFvBejVCgjSCfnIqGMJEeHptmHrt2g4,13292
+ansys/pyensight/core/utils/support.py,sha256=kHblfv4d286qz50P7q3aZr58G7yARSH9KhSMJemnxWg,5243
+ansys/pyensight/core/utils/variables.py,sha256=qy3Hup_3wUegwxDqoFoe_5xZ85J2ZvXF-mSZgiDYhCU,96287
+ansys/pyensight/core/utils/views.py,sha256=2BJS3z0lmiV5VVl36zaiLtO94t6eiADSFwVMCO0Uoqo,25862
+ansys/pyensight/core/utils/resources/Materials/000_sky.exr,sha256=xAR1gFd2uxPZDnvgfegdhEhRaqKtZldQDiR_-1rHKO0,8819933
+ansys_pyensight_core-0.11.0.dist-info/licenses/LICENSE,sha256=GkjtkVXMdcP9M4oZ-zdBaDA6JeocW5nItUIRr1ATj9s,1097
+ansys_pyensight_core-0.11.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+ansys_pyensight_core-0.11.0.dist-info/METADATA,sha256=QG85l_mXbhnHRdfYDVZmU9bXY9g096h-NQ-PUwI4zDI,12237
+ansys_pyensight_core-0.11.0.dist-info/RECORD,,

ansys_pyensight_core-0.11.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ansys_pyensight_core-0.11.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 - 2026 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.