Catalog PyPI
PACKAGE EXPLORERView in registry

acousticDE

PyPI

Acoustics Simulation using the Diffusion Equation

acousticacousticsdiffusionequationroomsimulations
Versions collected1
Direct dependencies15From release 0.1.0
Last observed20 Oct, 18:22 UTC

README

Version 0.1.0 documentation

Diffusion Equation Software for Room Acoustics Modeling

acousticDE is an open-source software package developed for the simulation of room acoustics based on the diffusion equation method. The package provides two complementary numerical implementations of this method: the Finite Volume Method (FVM) and the Finite Difference Method (FDM). In addition, it includes a tool for auralization enabling users to listen to acoustic renderings generated from the results of the Finite Volume Method. The main strength of acousticDE is in its ability to predict the distribution of acoustic energy over space and time within a given room. With only a minimal set of input parameters, the software delivers accurate and computationally efficient estimates of both the energy propagation and room acoustics properties. This makes it a valuable tool for researchers and practitioners interested in architectural acoustics. The software is being developed as part of an ongoing research within the Building Acoustics Group at the Department of Built Environment, Eindhoven University of Technology. It is currently under active development and implemented in Python by Ilaria Fichera.

Release version

Version 0.1.0

Repository structure

The package acousticDE is formed by three subfolders:

  • Auralization generates the auralization wav file for the room in question;
  • FiniteDifferenceMethod computes the room acoustics based on the diffusion equation using the finite difference method (Navarro et al., 2012);
  • FiniteVolumeMethod computes the room acoustics based on the diffusion equation using the finite volume method (Munoz, 2019);

Installation

Use pip to install acousticDE

pip install acousticDE

Once installed, in cmd window, use the following commands:

python

import acousticDE

To run FVM, continue with:

from acousticDE.FiniteVolumeMethod.FVM import run_fvm_sim

results = run_fvm_sim('C:\....\mesh.msh','C:\....\mesh_input_fvm.json','C:\....\absorption_coefficients.csv')

To run FDM, continue with:

from acousticDE.FiniteDifferenceMethod.FDM import run_fdm_sim

results = run_fdm_sim('C:\....\mesh_input_fdm.json')

To run Auralization, continue with:

from acousticDE.Auralization.Auralization import run_auralization_sim

results = run_auralization_sim('C:\....\anechoic_file.wav','C:\....\resultsFVM.pkl')

To run the codes/functions, check the documentation depending on the method you want to use, create the files needed for the specific function and check the Tutorial sections of the documentation.

Usage & Documentation

The documentation is created to help to use and develop acousticDE effectively. To use acousticDE, please refer to the Tutorial section of the documentation. In addition, the documentation gives an introduction of the package for both FDM and FVM.

Authors

Software is being developed by Ilaria Fichera at Eindhoven University of Technology (TU/e).

Funding

This research is founded by the Dutch Research Council (NWO), Applied and Engineering Sciences (AES) under grant agreement No. 19430, with project title "A new era of room acoustics simulation software: from academic advances to a sustainable open-source project and community".

License

Diffusion is under copyright of Building Acoustics Group at the Eindhoven University of Technology and is licensed under GNU General Public License v2.0. See LICENSE.md for more details.

References

J. M. Navarro, J. Escolano and J. J. Lopez, Implementation and evaluation of a diffusion equation model based on finite difference schemes for sound field prediction in rooms, Applied Acoustics 73 (2012).

R. P. Muñoz, Numerical modeling for urban sound propagation: developments in wave-based and energy based methods, PhD Thesis, Technische Universiteit Eindhoven, 2019.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
0.1.020 Jan 202615

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
building-acoustics-tu-eindhoven/acousticde

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 18:22 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:e3ae6740b8d63cd3a593afc1c85b461b02788e15a8ab4190c240d2f0552b95f6