Skip to content

Installation#

acoupi has been designed to run on single-board computer devices like the Raspberry Pi (RPi). Users should be able to download and test acoupi software on any Linux-based machine with Python version >=3.8,<3.12 installed.

Installation Requirements#

We recommend the following hardware elements to install and run acoupi.

  • A Linux-based single board computer such as the Raspberry Pi 4B.
  • A SD Card with 64-bit Lite OS version installed.
  • A USB Microphone such as an AudioMoth USB Microphone or an Ultramic 192K/250K.
Recommended Hardware

The software has been extensively developed and tested with the RPi 4B. We advise users to select the RPi 4B or a device featuring similar specifications.

Installation Steps#

Getting started with Raspberry Pi

If you are new to RPi, we recommend you reading and following the RPi's Getting started documentation.

To install and use the bare-bone framework of acoupi on your embedded device follow these steps:

Step 1: Install acoupi and its dependencies

CLI Command: install acoupi

curl -sSL https://github.com/acoupi/acoupi/raw/main/scripts/setup.sh | bash

Step 2: Configure an acoupi program.

acoupi includes a default program for recording and saving audio files based on your settings, similar to an AudioMoth setup. To start using it, enter the command:

CLI Command: setup acoupi default program

acoupi setup --program acoupi.programs.default

Step 3: To start a deployment of acoupi with the configured program run the command:

CLI Command: start a configured acoupi program

acoupi deployment start
Using acoupi from the command line

To check what are the available commands for acoupi, enter acoupi --help. Also look at the CLI documentation for further info.