Skip to content

QutEcoacoustics/ap-desktop

Repository files navigation

AP Desktop Logo

AP Desktop

Build Status License

Introduction

AP Desktop is a Graphical User Interface (GUI) for the open source program AnalysisPrograms.exe provided by QUT/EcoAcoustics. This GUI is designed to help researchers use the software without learning complicated terminal commands.

Currently runs with:

  • Angular v8.3.21
  • Electron v7.1.7
  • Electron Builder v21.2.0
  • Typescript: 3.5.3

Supported Platforms:

  • Windows 10
  • Linux Ubuntu 18 (deb, rpm)
  • Linux Ubuntu 16 (deb, rpm)

Getting Started

Requirements:

Windows Requirements:

Linux Requirements:

Clone this repository locally :

Running Project

git clone https://github.com/QutEcoacoustics/ap-desktop.git

Install dependencies with npm :

npm install

Windows:

npm run ap_download:windows

Linux:

npm run dependencies
npm run ap_download:linux

There is an issue with yarn and node_modules that are only used in electron on the backend when the application is built by the packager. Please use npm as dependencies manager.

To Build for Development

npm start

To Build for Production

Built programs can be found inside the ./release folder.

Windows

npm run electron:windows

Linux

npm run electron:linux

Max (Unsupported)

npm run electron:mac

Included Commands

Command Description
npm run ap_download:linux Downloads AP files required for AP Desktop to run
npm run ap_download:windows Downloads AP files required for AP Desktop to run
npm run build Build the app. Your built files are in the /dist folder.
npm run build:prod Build the app with Angular aot. Your built files are in the /dist folder.
npm run electron:local Builds your application and start electron
npm run electron:linux Builds your application and creates an app consumable on linux system
npm run electron:windows On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems
npm run electron:mac On a MAC OS, builds your application and generates a .app file of your application that can be run on Mac
npm run dependencies Automatically installs linux depedencies required to run AP

Current Features

  • Angular Framework
  • AP Installer
  • Pre-Built Analysis Tools
  • Support for running multiple analyses in one command
  • Advanced Analysis Options (UNTESTED)
    • Config File Editor
    • AP Options Editor

Features Coming Soon

  • Analysis spectrogram display
  • Link to Analysis Output
  • Event Detection Helper utility

History

Originally started as a VRES student project by Charles Alleman.