sndid/README.md

# sndid
`sndid` identifies sounds.


# Install
Install thusly.

Using Debian Stable (12/Bookworm).

Install thine dependencies:
```
sudo apt update
sudo apt install git ffmpeg python3-pip python3-virtualenv
```

Clone repo:
```
git clone https://spacecruft.org/deepcrayon/sndid
cd sndid/
```

If you want some sound samples, pull the submodule:

```
git submodule init
git submodule update
```


Set up Python to taste, such as:
```
virtualenv env
source env/bin/activate
pip install --upgrade pip setuptools wheel
```

Install Python dependencies:
```
pip install -r requirements.txt
```


# Usage
## Server


## Client


# Development
To "develop", install the requirements:

```
pip install -r requirements-dev.txt
```

Then run black on the Python files for nice formatting:

```
black *.py
```


# Upstream
## Birds
### BirdNet
* BirdNet is the main upstream project:
https://birdnet.cornell.edu/

* The source code is available here:
https://github.com/kahst/BirdNET-Analyzer

Unfortunately the project has a horrible license, CC-NC-BY-SA 4.0,
which isn't even a software license. The authors of the license
themselves say it shouldn't be used for software.
It's not just the data files,
such as the models that are NC (which would be ok), but the source
code itself is NC.
I haven't double checked the Python imports, but it would be interesting
to see if they are even compatible with the NC license,
since the NC license is incompatible with so many Free Software
and Open Source Software licenses.
There is a bug open to fix the license, and change it to Apache 2.0,
which would be sane.
I hope this happens:

https://github.com/kahst/BirdNET-Analyzer/issues/154


### birdnetlib
birdnetlib is based on BirdNet, but with a different codebase and author.
It uses the NC model files (afaict), and imports the non-free BirdNet-Analyzer (?),
but the source code to birdnetlib itself is
under the Apache 2.0 license, so it is Free Software / Open Source Software.


https://github.com/joeweiss/birdnetlib

XXX birdnetlib could be fully libre and only use BirdNet-Analyzer code for
testing, not production. Need to Confirm. XXX


# Copyright
Unofficial project, not related to BirdNet or Joe Weiss.

Upstream sources under their respective copyrights.


# License
Apache 2.0.

*Copyright © 2023, Jeff Moe.*