README.md

This repo is currently under development.

BirdNET-Electron

Electron app for sound file analysis with BirdNET.

Author: Stefan Kahl

Contact: [email protected]

Website: https://birdnet.cornell.edu/

Please cite as (PDF coming soon):

@phdthesis{kahl2019identifying,
  title={{Identifying Birds by Sound: Large-scale Acoustic Event Recognition for Avian Activity Monitoring}},
  author={Kahl, Stefan},
  year={2019},
  school={Chemnitz University of Technology}
}

Application setup

First, clone the project and install all dependencies:

git clone https://github.com/kahst/BirdNET-Electron.git
cd BirdNET-Electron
npm install

Next, launch the app with:

npm start

Development setup

Setting up the project requires Node.js, which we need to install first.

After that, we can initialize the source directory with:

npm init

Follow the prompt to setup package.json.

Now, we need to install electron with:

npm install --save-dev electron

BirdNET requires Tensorflow.js which we install with:

npm install @tensorflow/tfjs

Install Bootstrap and its dependencies:

npm install bootstrap
npm install jquery
npm install popper.js

This app also needs some additional packages that we have to install.

npm install audio-loader
npm install audio-resampler
npm install array-normalize
npm install colormap

In order to package the app for stand-alone applications, we need electron-packager:

npm install electron-packager --save-dev

We can now add the export script in the package.json:

"scripts": {
    "start": "electron .",
    "export": "electron-packager . --out dist --overwrite"
  }

After that, we can export the app with:

npm run export