Metadata-Version: 2.1
Name: ansys-sound-core
Version: 0.1.1
Summary: A Python wrapper for Ansys DPF Sound.
Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
License: 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.
        
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: <4,>=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: ansys-dpf-core <1,>=0.9.0
Requires-Dist: matplotlib <4,>=3.8.2
Requires-Dist: platformdirs <5,>=4.2.2
Provides-Extra: doc
Requires-Dist: Sphinx ==7.3.7 ; extra == 'doc'
Requires-Dist: ansys-sphinx-theme ==0.16.6 ; extra == 'doc'
Requires-Dist: numpydoc ==1.7.0 ; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints ==2.2.2 ; extra == 'doc'
Requires-Dist: sphinx-copybutton ==0.5.2 ; extra == 'doc'
Requires-Dist: sphinx-gallery ==0.16.0 ; extra == 'doc'
Requires-Dist: sphinx-design ==0.6.0 ; extra == 'doc'
Requires-Dist: vtk ==9.3.1 ; extra == 'doc'
Requires-Dist: trame ==3.6.3 ; extra == 'doc'
Requires-Dist: trame-vtk ==2.8.9 ; extra == 'doc'
Requires-Dist: pyvista ==0.44.0 ; extra == 'doc'
Requires-Dist: pypandoc ==1.13 ; extra == 'doc'
Requires-Dist: jupyter-sphinx ==0.5.3 ; extra == 'doc'
Requires-Dist: sphinx-autobuild ==2024.4.16 ; extra == 'doc'
Requires-Dist: platformdirs ==4.2.2 ; extra == 'doc'
Provides-Extra: tests
Requires-Dist: ansys-dpf-core ==0.12.2 ; extra == 'tests'
Requires-Dist: matplotlib ==3.8.4 ; extra == 'tests'
Requires-Dist: pytest ==8.2.2 ; extra == 'tests'
Requires-Dist: pytest-cov ==5.0.0 ; extra == 'tests'
Requires-Dist: pytest-dependency ==0.6.0 ; extra == 'tests'
Requires-Dist: platformdirs ==4.2.2 ; extra == 'tests'
Requires-Dist: regex ==2024.5.15 ; extra == 'tests'

PyAnsys Sound
=============

|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black| |pre-commit.ci|

.. |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-sound-core?logo=pypi
   :target: https://pypi.org/project/ansys-dpf-sound/
   :alt: Python

.. |pypi| image:: https://img.shields.io/pypi/v/ansys-sound-core.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/ansys-sound-core
   :alt: PyPI

.. |codecov| image:: https://codecov.io/gh/ansys/pyansys-sound/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/ansys/pyansys-sound/
   :alt: Codecov

.. |GH-CI| image:: https://github.com/ansys/pyansys-sound/actions/workflows/ci_cd.yml/badge.svg
   :target: https://github.com/ansys/pyansys-sound/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

.. |pre-commit.ci| image:: https://results.pre-commit.ci/badge/github/ansys/pyansys-sound/main.svg
   :target: https://results.pre-commit.ci/latest/github/ansys/pyansys-sound/main
   :alt: pre-commit.ci status

PyAnsys Sound lets you use the main features of `Ansys Sound`_ to perform
the postprocessing and analysis of sounds and vibrations in Python. This library is based on
`PyDPF-Core`_ and the DPF Sound plugin. It is a Python wrapper that implements classes on top
of DPF Sound operators

Documentation and issues
------------------------
Documentation for the latest stable release of PyAnsys Sound is hosted at
`PyAnsys Sound documentation <https://sound.docs.pyansys.com/version/stable/>`_.

The documentation has these sections:

- `Getting started <https://sound.docs.pyansys.com/version/stable/getting_started.html>`_: Learn
  how to install PyAnsys Sound in user mode.
- `User guide <https://sound.docs.pyansys.com/version/stable/user_guide.html>`_: Learn how to start
  a DPF server, load a signal from a WAV file, and perform operations on the signal.
- `API reference <https://sound.docs.pyansys.com/version/stable/api/index.html>`_: Understand how
  to use Python to interact programmatically with PyAnsys Sound.
- `Examples <https://sound.docs.pyansys.com/version/stable/examples/index.html>`_: Explore examples
  that show how to use PyAnsys Sound for various workflows.
- `Contribute <https://sound.docs.pyansys.com/version/stable/contribute.html>`_: Learn how to
  contribute to the PyAnsysSound codebase or documentation.

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.

.. LINKS AND REFERENCES
.. _Ansys Sound: https://www.ansys.com/sound
.. _PyDPF-Core: https://dpf.docs.pyansys.com/version/stable/
