Depending on your operating system and python distribution, there are different options (see below) how to install Acoular.
Acoular runs under 64bit Windows and Linux (it should also run under OS X, but this is untested). In order to install Acoular you need a Python 3 environment running on your machine. Furthermore, Acoular requires the following Python Packages:
If you do not chose option 1 below for installation, you may have to take care that these are all installed on your machine before you can install Acoular.
In order to run the demo and examples you will also need:
and for the example_3D_beamforming:
Option 1 (recommended): Anaconda (Windows and Linux)¶
This option assumes that you have the Anaconda Python-distribution installed on your computer. If this is not the case you may download and install it (higly recommended). You may install Anaconda alongside any other Python installation on your system, without the need to interfere with the other Python installation.
Once Anaconda Python is properly installed and works, start a console, i.e. either “cmd” or the “Anaconda command prompt” on Windows, Terminal on Linux. In the command line, type
$ conda install -c acoular acoular
This will install Acoular in your Anaconda Python enviroment and make the Acoular library available from Python. In addition, this will install all dependencies (those other packages mentioned above) if they are not already present on your system. Depending on your type of Anaconda installation (single user or system-wide), you may be asked for admin privileges in order to start the installation process.
Option 2: Windows with other Python distributions¶
Download and run the windows installer. You will have to take care by yourself that all required packages are installed, otherwise you will not be able to use Acoular.
Option 3: pip¶
If you have pip installed on your system, you may type
$ pip install acoular
to install acoular. Note that the required packages are not installed this way and you have to do it by yourself.
Option 4: Source install¶
You may download the source tarball. Unzip it and change into the “acoular” directory, then type
$ python setup.py install
to compile and install the software. This requires a properly set up system with all installed dependencies and a compiler. Another option to get the source is to clone or fork from Github.
Verify Acoular installation¶
If the installation has finished, you may try out Acoular by importing the module and running the acoular demo script in a Python console.
> import acoular > acoular.demo.acoular_demo.run()
After some seconds, this should produce two pictures (a 64 microphone arrangement and a beamforming map with three sources).