eac-ufsm / fia2022-augen

FIA 2020/2022 - Augen - Amiet-Acoular Integration Module in Python

This is the English version of this documentation file. For the Brazilian Portuguese version of this text click here.

Augen (version: 0.1.0)

This repository is a frozen version, to access the version with updates, click here. The version contained herein is the same used to carry out the work presented in the FIA 2020/2022.

Augen is a toolbox designed to create a direct integration between Acoular [1] and Amiet Tools [2]. It also provides a few functions written in Matlab to provide support for using toolboxes like ITA-Toolbox [3] and Beamap [4].

The name Augen is an acronym for Amiet-Acoular Integration Module in Python.

The article that presents this toolbox is available on Research Gate:

• Integration of multiple toolboxes for application in beamforming and aeroacoustics.

Installation

Note: If you are a GitHub Desktop user, you still will need to follow the steps below.

Procedure

1.0 There are two methods to use the toolbox, 1.1 which uses directly the Python installation or 1.2 with an Anaconda environment.

1.1 Install Python 3.8.10 and git to be able to proceed with the installation.

1.2 Create an Anaconda environment for Python 3.8.10 with conda create -n env_name python=3.8.10.

2.0 Install all the dependencies from list below (read [A]):

• Python == 3.8.10
• SciPy == 1.7.1
• NumPy == 1.20.3
• Amiet Tools == 0.0.2
• Acoular == 21.5
  • scikit-learn (a.k.a. sklearn)== 0.24.2
  • Numba == 0.54.0
  • six >= 1.1.0
  • pytables (a.k.a. tables) == 3.6.1
  • Traits == 6.2.0
  • TraitsUI == 7.2.1
  • libpython
• Matplotlib == 3.7.4
• PyQt5 == 5.15.10
• h5py == 3.10.0

Warning: Since Amiet Tools isn't yet available in PyPI, make sure to run the following command before installing Augen:

pip install git+https://github.com/fchirono/amiet_tools

2.1 Check with the command pip list if all the dependecides are installed with the correct version. Don't forget to read [A].

3.0. After installing all the dependencies required, the next step is the installation of Augen by simply running the following command via PIP:

pip install git+https://github.com/eac-ufsm/fia2022-augen

[A] How to install an old version of a dependency

To install in Python a module/package via PIP the following command is used: pip install example_module.

In cases where a specific version of a module is required, the following command is applied:

pip install example_module==x.x.x,

in which x.x.x should be the desired version, an example is that instead of x.x.x it would be 1.7.1.

Tutorial

The examples folder has scripts that are focused on exemplifying the usage of the toolbox, with scripts well commented on.

The results from the spiral microphone array example

Important notes

• The folder simple_tests contains a small number of scripts focused on testing the different classes and scripts provided by the tool. This folder isn't a folder of pythonic testing.

• The folder Matlab makes available a few functions written in Matlab to be used together with toolboxes like ITA-Toolbox and Beamap — geared towards saving/reading in XML file format, the microphone array geometry.

About the authors

Michael Markus Ackermann is an Acoustical Engineering undergraduate student at the Federal University of Santa Maria (UFSM) in south Brazil. Augen is created by Michael as part of his Bachelor's Thesis — which focused on Aeroacoustics and Acoustical Beamforming (moreover, it expands a Python branch from Beamap).

William D'Andrea Fonseca is a Professor of the Acoustical Engineering undergraduate course in South Brazil (advising master and undergrad projects) at the Federal University of Santa Maria (UFSM). William does research in Acoustic Engineering, Electrical Engineering, and Aerospace Engineering. His current projects includes: Beamforming, Instrumentation, Signal Processing, and Education in Acoustics, Audio, and Vibration (more research information in his RG profile).

Cite us

M. M. Ackermann, W. D’A. Fonseca, P. H. Marezev, and F. C. Hirono. Integration of multiple toolboxes for application in beamforming and aeroacoustics (original: Integracão de múltiplas toolboxes para aplicação em beamforming e aeroacústica). In 12th Iberoamerican Congress of Acoustics (FIA 2020/22) & Meeting of the Brazilian Society of Acoustics - Sobrac. Florianópolis, SC, Brazil, 2022. URL: https://bit.ly/fia2022-augen.

BibTex:

@article{augen-2022,
author = {Ackermann, Michael Markus and Fonseca, William {\relax D'A}ndrea, and Mareze, Paulo Henrique and Casagrande Hirono, Fábio},
title = {Integration of multiple toolboxes
for application in beamforming and aeroacoustics  (original: Integracão de múltiplas toolboxes para aplicação em beamforming e aeroacústica)},
booktitle = {In 12th Iberoamerican Congress of Acoustics (FIA 2020/22) \& Meeting of the Brazilian Society of Acoustics - Sobrac.},
date = {2022},
address = {Florianópolis, SC, Brazil},
url = {https://bit.ly/fia2022-augen}
}

References

[1] Sarradj, Ennes and Herold, Gert. A Python framework for microphone array data processing (Acoular - Acoustic Testing and Source Mapping Software). Applied Acoustics, 116:50–58, 2017. ISSN 0003-682X. DOI: 10.1016/j.apacoust.2016.09.015. The toolbox available at: http://acoular.org.

[2] Casagrande Hirono, Fabio; Joseph, Phillip; and Fazi, Filippo M. An Open–Source Implementation of Analytical Turbulence–Airfoil Interaction Noise Model. In AIAA Aviation 2020 Forum, number AIAA 2020-2544, pages 1–21. American Institute of Aeronautics and Astronautics, 2020. DOI: 10.2514/6.2020-2544. The toolbox is available at: https://github.com/fchirono/amiet_tools.

[3] Dietrich, Pascal; Guski, Martin; Pollow, Martin; Müller-Trapet, Markus; Masiero, Bruno; Scharrer, Ro man and Vorlaender, Michael. ITA-Toolbox – An Open Source Matlab Toolbox for Acousticians. In 38th German Annual Conference on Acoustics (DAGA), number 38, pages 151–152, Darmstadt, Germany, 2012. Available in: https://pub.dega-akustik.de/DAGA_2012/data/articles/000164.pdf. The toolbox is available at: https://git.rwth-aachen.de/ita/toolbox.

[4] Fonseca, William D’Andrea; Mareze, Paulo H.; Mello, Felipe R. and Fonseca, Carlos Calixto. Teaching Acoustical Beamforming via Active Learning Approach. In 9th Berlin Beamforming Conference (BeBeC), number BeBeC-2022-D4, Berlim, Germany, June 2022. Available in: BeBeC 2022.