Skip to content

Silvasonic is a professional-grade, containerized recording system designed for long-term bioacoustic monitoring in the field. The goal for **v1.0.0** is to transform a Raspberry Pi 5 into a resilient recording station capable of capturing the entire soundscape — from avian vocalizations to ultrasonic bat calls.

License

Notifications You must be signed in to change notification settings

kyellsen/silvasonic

Repository files navigation

Silvasonic

Autonomous Bioacoustic Recording Station for Raspberry Pi 5

Status: v0.1.0 — Foundation


What is Silvasonic?

Silvasonic is a professional-grade, containerized recording system designed for long-term bioacoustic monitoring in the field. The goal for v1.0.0 is to transform a Raspberry Pi 5 into a resilient recording station capable of capturing the entire soundscape — from avian vocalizations to ultrasonic bat calls.

Target Audience: Researchers, conservationists, and bioacoustic enthusiasts requiring robust, unsupervised data collection.

For the long-term vision, design philosophy, and roadmap see VISION.md.


Quick Start

Prerequisites

  • Linux (e.g., Debian or Fedora)
  • uv installed
  • just installed — command runner (Installation)
  • Podman & podman-compose installed

Setup

git clone https://github.com/kyellsen/silvasonic.git
cd silvasonic
cp .env.example .env   # adjust settings as needed
just init               # create workspace directories & pull images
just build              # build all container images
just start              # start all services

Project Structure

silvasonic/
├── AGENTS.md            # AI agent rules (binding for all AI tools)
├── VISION.md            # Long-term vision & roadmap
├── compose.yml          # Container orchestration
├── justfile             # Developer commands (init, build, start, stop, clean, nuke)
├── docs/                # Single Source of Truth — architecture, ADRs, specs
│   └── index.md         # Documentation entry point
├── packages/            # Shared Python packages (namespace: silvasonic.*)
├── services/            # Container service definitions & Containerfiles
├── scripts/             # Build & lifecycle scripts
└── tests/               # Cross-cutting tests

Current Services

The architecture is organized into Tier 1 (Infrastructure, managed by Podman Compose) and Tier 2 (Application, managed by Controller, immutable). Currently implemented:

Service Tier Role Status
database 1 TimescaleDB / PostgreSQL — central state management ✅ Running
controller 1 Hardware/Container manager — health monitoring, placeholder orchestration ✅ Scaffold
recorder 2 Audio Capture — health monitoring, placeholder recording loop ✅ Scaffold

For the full target architecture (13 services across two tiers) see VISION.md.


Key Documentation

Document Audience Purpose
README.md 👤 Humans Project overview, quick start, structure
VISION.md 👤 + 🤖 Vision, services architecture, design philosophy, roadmap
AGENTS.md 🤖 AI Agents Binding rules, constraints & conventions for AI coding assistants
docs/index.md 👤 + 🤖 Full technical documentation (architecture, ADRs, specs)

🤖 AI Agents: Your instructions are in AGENTS.md. Read it first before doing any work on this repository.


Contact


Licence

See LICENCE.

About

Silvasonic is a professional-grade, containerized recording system designed for long-term bioacoustic monitoring in the field. The goal for **v1.0.0** is to transform a Raspberry Pi 5 into a resilient recording station capable of capturing the entire soundscape — from avian vocalizations to ultrasonic bat calls.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published