Skip to content

Installation#

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

Installation Requirements#

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

  • A Linux-based single-board computer such as the Raspberry Pi 4B.
  • A SD Card with 64-bit Lite OS version installed.
  • An audible frequency range microphone, such as an AudioMoth USB Microphone or a Lavalier.
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 or higher 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 acoupi_birdnet 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: Install acoupi_birdnet.

CLI Command: install acoupi_birdnet

pip install acoupi_birdnet

Step 3: Configure the acoupi_birdnet program.

acoupi_birdnet program includes multiple components for recording, processing, saving and deleting audio files, as well as sending detections and summary messages to a remote server. Enter the following command to configure the program according to your needs.

CLI Command: configure acoupi_birdnet program

acoupi setup --program acoupi_birdnet.program

Step 4: To start a deployment of acoupi_birdnet, run the command:

CLI Command: start the configured acoupi_birdnet program

acoupi deployment start