claudecode/AvianVisitors
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cleanup the readme a bit

Browse Source
This commit is contained in:
frederik
2025-11-17 19:05:53 +01:00
parent 9abef81536
commit 7c917e7d07
3 changed files with 46 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -81
View File
@@ -24,10 +24,10 @@ Changes include:
- Bump apprise version, so more notification type are possible
- Swipe events on Daily Charts (by @croisez)
- Support for 'Species range model V2.4 - V2'
- Bookworm support
- Bookworm and Trixie support
- Experimental support for writing transient files to tmpfs
- Rework analysis to consolidate analysis/server/extraction. Should make analysis more robust and slightly more efficient, especially on installations with a large number of recordings
- Bump tflite_runtime to 2.11.0, it is faster
- Bump tflite_runtime to 2.17.1, it is faster
- Rework daily_plot.py (chart_viewer) to run as a daemon to avoid the very expensive startup
- Lots of fixes & cleanups
@@ -39,48 +39,6 @@ BirdNET-Pi is built on the [BirdNET framework](https://github.com/kahst/BirdNET-
Check out birds from around the world
- [BirdWeather](https://app.birdweather.com)<br>
Currently listening in these countries . . . that I know of . . .
- The United States
- Germany
- South Africa
- France
- Austria
- Sweden
- Scotland
- Norway
- England
- Italy
- Finland
- Australia
- Canada
- Switzerland
- Romania
- Spain
- New Zealand
- Russia
- Croatia
- Belgium
- Israel
- Ireland
- Denmark
- Costa Rica
- The Philippines
- Hungary
- South Sudan
- Argentina
- Brazil
- Thailand
- Colombia
- Estonia
- Tasmania
- Luxembourg
- Crete
- Rwanda
- Oman
- Belarus
- Czech Republic
- Japan
## Features
* **24/7 recording and automatic identification** of bird songs, chirps, and peeps using BirdNET machine learning
* **Automatic extraction and cataloguing** of bird clips from full-length recordings
@@ -100,7 +58,7 @@ Currently listening in these countries . . . that I know of . . .
## Requirements
* A Raspberry Pi 5, Raspberry 4B, Raspberry Pi 400, Raspberry Pi 3B+, or Raspberry Pi 0W2 (The 3B+ and 0W2 must run on RaspiOS-ARM64-**Lite**)
* An SD Card with the **_64-bit version of RaspiOS_** installed (please use Bookworm) -- Lite is recommended, but the installation works on RaspiOS-ARM64-Full as well. Downloads available within the [Raspberry Pi Imager](https://www.raspberrypi.com/software/).
* An SD Card with the **_64-bit version of RaspiOS_** installed (please use Trixie) -- Lite is recommended, but the installation works on RaspiOS-ARM64-Full as well. Downloads available within the [Raspberry Pi Imager](https://www.raspberrypi.com/software/).
* A USB Microphone or Sound Card
## Installation
@@ -153,8 +111,8 @@ To restore:
./scripts/backup_data.sh -a restore -f /mnt/birds/backup-2024-07-09.tar
```
## x86_64 support*
***x86_64 is not supported.** Not officially anyway. It is mainly there for developers or otherwise more Linux savvy people.
## x86_64 support
x86_64 support is mainly there for developers or otherwise more Linux savvy people.
That being said, some pointers:
- Use Debian 12
- The user needs passwordless sudo
@@ -205,49 +163,20 @@ For more information : https://github.com/alexbelgium/hassio-addons/blob/master/
- [Marie Lelouche's <i>Out of Spaces</i>](https://www.lestanneries.fr/exposition/marie-lelouche-out-of-spaces/) using BirdNET-Pi in post-sculpture VR! [Press Kit](https://github.com/mcguirepr89/BirdNET-Pi-assets/blob/main/dp_out_of_spaces_marie_lelouche_digital_05_01_22.pdf)
- [Research on noded BirdNET-Pi networks for farming](https://github.com/mcguirepr89/BirdNET-Pi-assets/blob/main/G23_Report_ModelBasedSysEngineering_FarmMarkBirdDetector_V1__Copy_.pdf)
- [PixCams Build Guide](https://pixcams.com/building-a-birdnet-pi-real-time-acoustic-bird-id-station/)
- <ins>[Core-Electronics](https://core-electronics.com.au/projects/bird-calls-raspberry-pi)</ins> Build Article
- [Core-Electronics](https://core-electronics.com.au/projects/bird-calls-raspberry-pi) Build Article
- [RaspberryPi.com Blog Post](https://www.raspberrypi.com/news/classify-birds-acoustically-with-birdnet-pi/)
- [MagPi Issue 119 Showcase Article](https://magpi.raspberrypi.com/issues/119/pdf)
### Internationalization:
The bird names are in English by default, but other localized versions are available thanks to the wonderful efforts of [@patlevin](https://github.com/patlevin). Use the web interface's "Tools" > "Settings" and select your "Database Language" to have the detections in your language.
The bird names are in English by default, but other localized versions are available thanks to the wonderful efforts of [@patlevin](https://github.com/patlevin) and Wikipedia. Use the web interface's "Tools" > "Settings" and select your "Database Language" to have the detections in your language.
[Internationalization](docs/translations.md)
Current database languages include the list below:
| Language | Missing Species out of 6,362 | Missing labels (%) |
| -------- | ------- | ------ |
| Afrikaans | 5774 | 90.76% |
| Catalan | 544 | 8.55% |
| Chinese | 264 | 4.15% |
| Croatian | 370 | 5.82% |
| Czech | 683 | 10.74% |
| Danish | 460 | 7.23% |
| Dutch | 264 | 4.15% |
| Estonian | 3171 | 49.84% |
| Finnish | 518 | 8.14% |
| French | 264 | 4.15% |
| German | 264 | 4.15% |
| Hungarian | 2688 | 42.25% |
| Icelandic | 5588 | 87.83% |
| Indonesian | 5550 | 87.24% |
| Italian | 524 | 8.24% |
| Japanese | 640 | 10.06% |
| Latvian | 4821 | 75.78% |
| Lithuanian | 597 | 9.38% |
| Norwegian | 325 | 5.11% |
| Polish | 265 | 4.17% |
| Portuguese | 2742 | 43.10% |
| Russian | 808 | 12.70% |
| Slovak | 264 | 4.15% |
| Slovenian | 5532 | 86.95% |
| Spanish | 348 | 5.47% |
| Swedish | 264 | 4.15% |
| Thai | 5580 | 87.71% |
| Ukrainian | 646 | 10.15% |
## Screenshots
![Overview](docs/overview.png)
![chrome_HNMJKSPwV0](https://user-images.githubusercontent.com/103586016/217896322-aee3ecc4-e40e-40df-ade1-79f05ded21f2.png)
![Spectrogram](docs/spectrogram.png)
## :thinking:
docs/spectrogram.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 356 KiB

docs/translations.md
+36
View File
@@ -0,0 +1,36 @@
| Language | Translated species | Translated species (%) |
| -------- | ------- | ------ |
| Afrikaans | 743 | 10.5% |
| Arabic | 526 | 7.5% |
| Catalan | 5818 | 82.4% |
| Chinese | 6174 | 87.5% |
| Croatian | 5995 | 84.9% |
| Czech | 6049 | 85.7% |
| Danish | 5944 | 84.2% |
| Dutch | 6707 | 95.0% |
| Estonian | 3230 | 45.8% |
| Finnish | 6377 | 90.4% |
| French | 6782 | 96.1% |
| German | 6790 | 96.2% |
| Hungarian | 3728 | 52.8% |
| Icelandic | 827 | 11.7% |
| Indonesian | 865 | 12.3% |
| Italian | 5794 | 82.1% |
| Japanese | 6659 | 94.3% |
| Korean | 616 | 8.7% |
| Latvian | 1588 | 22.5% |
| Lithuanian | 5812 | 82.3% |
| Norwegian | 6727 | 95.3% |
| Polish | 6786 | 96.1% |
| Portuguese | 6400 | 90.7% |
| Romanian | 807 | 11.4% |
| Russian | 6643 | 94.1% |
| Serbian | 5391 | 76.4% |
| Slovak | 6782 | 96.1% |
| Slovenian | 1190 | 16.9% |
| Spanish | 6746 | 95.6% |
| Swedish | 6733 | 95.4% |
| Thai | 994 | 14.1% |
| Turkish | 6361 | 90.1% |
| Ukrainian | 6680 | 94.6% |