Metadata-Version: 2.2
Name: pyfar
Version: 0.7.2
Summary: Project for data formats in acoustics.
Author-email: The pyfar developers <info@pyfar.org>
License: Copyright (c) [2020] [The pyfar developers]
        
        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.
        
Project-URL: Tracker, https://github.com/pyfar/pyfar/issues
Project-URL: Documentation, https://pyfar.readthedocs.io/
Project-URL: Download, https://pypi.org/project/pyfar/
Project-URL: Homepage, https://pyfar.org/
Project-URL: Source, https://github.com/pyfar/pyfar
Project-URL: Changelog, https://github.com/pyfar/pyfar/blob/main/HISTORY.rst
Keywords: pyfar,acoustics,Fourier transforms,audio signal processing,filterbanks,parametric filters,audio signal visualization,read and write audio signals
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
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-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.23.0
Requires-Dist: scipy>=1.5.0
Requires-Dist: matplotlib
Requires-Dist: sofar>=0.1.2
Requires-Dist: urllib3
Requires-Dist: deepdiff
Requires-Dist: soundfile>=0.11.0
Provides-Extra: deploy
Requires-Dist: twine; extra == "deploy"
Requires-Dist: wheel; extra == "deploy"
Requires-Dist: build; extra == "deploy"
Requires-Dist: setuptools; extra == "deploy"
Requires-Dist: bump-my-version; extra == "deploy"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: watchdog; extra == "tests"
Requires-Dist: ruff==0.4.1; extra == "tests"
Requires-Dist: coverage; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: autodocsumm>=0.2.14; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx_mdinclude; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-favicon; extra == "docs"
Requires-Dist: sphinx-reredirects; extra == "docs"
Provides-Extra: dev
Requires-Dist: pyfar[deploy,docs,tests]; extra == "dev"

<h1 align="center">
<img src="https://github.com/pyfar/gallery/raw/main/docs/resources/logos/pyfar_logos_fixed_size_pyfar.png" width="300">
</h1><br>


[![PyPI version](https://badge.fury.io/py/pyfar.svg)](https://badge.fury.io/py/pyfar)
[![Documentation Status](https://readthedocs.org/projects/pyfar/badge/?version=latest)](https://pyfar.readthedocs.io/en/latest/?badge=latest)
[![CircleCI](https://circleci.com/gh/pyfar/pyfar.svg?style=shield)](https://circleci.com/gh/pyfar/pyfar)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)


The python package for acoustics research (pyfar) offers classes to store
audio data, filters, coordinates, and orientations. It also contains functions
for reading and writing audio data, as well as functions for processing,
generating, and plotting audio signals.

Getting Started
===============

The [pyfar workshop](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
gives an overview of the most important pyfar functionality and is a good
starting point. It is part of the [pyfar example gallery](https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html)
that also contains more specific and in-depth
examples that can be executed interactively without a local installation by
clicking the mybinder.org button on the respective example. The
[pyfar documentation](https://pyfar.readthedocs.io) gives a detailed and complete overview of pyfar. All
these information are available from [pyfar.org](https://pyfar.org).

Installation
============

Use pip to install pyfar

    pip install pyfar

(Requires Python 3.9 or higher)

Audio file reading/writing is supported through [SoundFile](https://python-soundfile.readthedocs.io), which is based on
[libsndfile](http://www.mega-nerd.com/libsndfile/). On Windows and OS X, it will be installed automatically.
On Linux, you need to install libsndfile using your distribution’s package manager, for example ``sudo apt-get install libsndfile1``.
If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).

Contributing
============

Check out the [contributing guidelines](https://pyfar.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar.
