https://github.com/pyfar/pyfar

python package for acoustics research
https://github.com/pyfar/pyfar

audio-in-out digital-signal-processing plotting

Last synced: 12 days ago
JSON representation

python package for acoustics research

• Host: GitHub
• URL: https://github.com/pyfar/pyfar
• Owner: pyfar
• License: mit
• Created: 2020-10-27T19:13:03.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T08:31:25.000Z (12 months ago)
• Last Synced: 2024-10-29T09:51:14.214Z (12 months ago)
• Topics: audio-in-out, digital-signal-processing, plotting
• Language: Python
• Homepage: https://pyfar.org
• Size: 48.2 MB
• Stars: 74
• Watchers: 6
• Forks: 13
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-acoustic - Pyfar

README

          







[![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.