birdnet 0.1.0__tar.gz

birdnet-0.1.0/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-07-23
+
+- Initial release
+
+[Unreleased]: https://github.com/birdnet-team/birdnet/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/birdnet-team/birdnet/releases/tag/v0.1.0

birdnet-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[github@stefantaubert.com](mailto:github@stefantaubert.com).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

birdnet-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+If you notice an error, please don't hesitate to open an issue.
+
+## Development setup
+
+```sh
+# update
+sudo apt update
+# install Python 3.9-3.11 for ensuring that tests can be run
+sudo apt install python3-pip \
+  python3.9 python3.9-dev python3.9-distutils python3.9-venv \
+  python3.10 python3.10-dev python3.10-distutils python3.10-venv \
+  python3.11 python3.11-dev python3.11-distutils python3.11-venv
+# install pipenv for creation of virtual environments
+python3.8 -m pip install pipenv --user
+
+# check out repo
+git clone https://github.com/birdnet-team/birdnet.git
+cd birdnet
+# create virtual environment
+python3.8 -m pipenv install --dev
+```
+
+## Running the tests
+
+```sh
+# first install the tool like in "Development setup"
+# then, navigate into the directory of the repo (if not already done)
+cd birdnet
+# activate environment
+python3.8 -m pipenv shell
+# run tests
+tox
+```
+
+Final lines of test result output:
+
+```log
+  py39: commands succeeded
+  py310: commands succeeded
+  py311: commands succeeded
+  congratulations :)
+```

birdnet-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 birdnet-team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

birdnet-0.1.0/MANIFEST.in

@@ -0,0 +1,26 @@
+graft src/birdnet_tests/
+
+include \
+  pylintrc \
+  CHANGELOG.md \
+  CODE_OF_CONDUCT.md \
+  CONTRIBUTING.md \
+  LICENSE.md \
+  MANIFEST.in \
+  Pipfile \
+  Pipfile.lock \
+  README.md \
+  pyproject.toml \
+  setup.cfg \
+  example/soundscape.wav \
+  example/example.py \
+  example/species_list.txt
+
+global-exclude \
+  *~ \
+  *.py[cod] \
+  *.so \
+  .DS_Store
+
+prune .*/
+prune **/__pycache__/

birdnet-0.1.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.1
+Name: birdnet
+Version: 0.1.0
+Summary: A Python library for identifying bird species by their sounds.
+Author-email: Stefan Taubert <pypi@stefantaubert.com>
+Maintainer-email: Stefan Taubert <pypi@stefantaubert.com>
+License: MIT
+Project-URL: Homepage, https://github.com/birdnet-team/birdnet
+Project-URL: Issues, https://github.com/birdnet-team/birdnet/issues
+Keywords: birds
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: BSD
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Unix
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: <3.12,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: librosa<1.0.0,>=0.10.0
+Requires-Dist: tensorflow==2.15.1
+Requires-Dist: resampy<1.0.0,>=0.4.3
+Requires-Dist: soundfile<1.0.0,>=0.12.1
+Requires-Dist: scipy<2.0.0,>=1.9.3
+Requires-Dist: ordered-set<5.0.0,>=4.1.0
+Requires-Dist: tqdm<5.0.0,>=4.64.1
+Requires-Dist: numpy<2.0.0,>=1.23.5
+
+# birdnet
+
+[![PyPI](https://img.shields.io/pypi/v/birdnet.svg)](https://pypi.python.org/pypi/birdnet)
+![PyPI](https://img.shields.io/pypi/pyversions/birdnet.svg)
+[![MIT](https://img.shields.io/github/license/birdnet-team/birdnet.svg)](https://github.com/birdnet-team/birdnet/blob/main/LICENSE.md)
+
+A Python library for identifying bird species by their sounds.
+
+## Installation
+
+```sh
+pip install birdnet --user
+```
+
+## Example usage
+
+### Identify species within an audio file
+
+```py
+from pathlib import Path
+
+from birdnet.models import ModelV2M4
+
+# create model instance for v2.4
+model = ModelV2M4()
+
+# predict species within the whole audio file
+audio_path = Path("example/soundscape.wav")
+predictions = model.predict_species_within_audio_file(audio_path)
+
+# get most probable prediction at time interval 0s-3s
+prediction, confidence = list(predictions[(0.0, 3.0)].items())[0]
+print(f"predicted '{prediction}' with a confidence of {confidence:.6f}")
+# output:
+# predicted 'Poecile atricapillus_Black-capped Chickadee' with a confidence of 0.814056
+```
+
+For a more detailed prediction you can take a look at [example/example.py](./example/example.py).
+
+### Predict species for a given location and time
+
+```py
+from birdnet.models import ModelV2M4
+
+# create model instance for v2.4
+model = ModelV2M4()
+
+# predict species
+predictions = model.predict_species_at_location_and_time(42.5, -76.45, week=4)
+
+# get most probable prediction
+first_prediction, confidence = list(predictions.items())[0]
+print(f"predicted '{first_prediction}' with a confidence of {confidence:.6f}")
+# output:
+# predicted 'Cyanocitta cristata_Blue Jay' with a confidence of 0.927620
+```
+
+### Predict species within an audio file for a given location and time
+
+```py
+from pathlib import Path
+
+from birdnet.models import ModelV2M4
+
+# create model instance for v2.4
+model = ModelV2M4()
+
+# predict species within the whole audio file
+audio_path = Path("example/soundscape.wav")
+
+species_in_area = model.predict_species_at_location_and_time(42.5, -76.45, week=4)
+predictions = model.predict_species_within_audio_file(
+  audio_path,
+  filter_species=set(species_in_area.keys())
+)
+
+# get most probable prediction at time interval 0s-3s
+prediction, confidence = list(predictions[(0.0, 3.0)].items())[0]
+print(f"predicted '{prediction}' with a confidence of {confidence:.6f}")
+# output:
+# predicted 'Poecile atricapillus_Black-capped Chickadee' with a confidence of 0.814056
+```
+
+## License
+
+- **Source Code**: The source code for this project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+- **Models**: The models used in this project are licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+
+Please ensure you review and adhere to the specific license terms provided with each model. Note that educational and research purposes are considered non-commercial use cases.
+
+## Citation
+
+```bibtex
+@article{kahl2021birdnet,
+  title={BirdNET: A deep learning solution for avian diversity monitoring},
+  author={Kahl, Stefan and Wood, Connor M and Eibl, Maximilian and Klinck, Holger},
+  journal={Ecological Informatics},
+  volume={61},
+  pages={101236},
+  year={2021},
+  publisher={Elsevier}
+}
+```
+
+## Funding
+
+This project is supported by Jake Holshuh (Cornell class of '69) and The Arthur Vining Davis Foundations. Our work in the K. Lisa Yang Center for Conservation Bioacoustics is made possible by the generosity of K. Lisa Yang to advance innovative conservation technologies to inspire and inform the conservation of wildlife and habitats.
+
+The German Federal Ministry of Education and Research is funding the development of BirdNET through the project "BirdNET+" (FKZ 01|S22072).
+Additionally, the German Federal Ministry of Environment, Nature Conservation and Nuclear Safety is funding the development of BirdNET through the project "DeepBirdDetect" (FKZ 67KI31040E).
+
+## Partners
+
+BirdNET is a joint effort of partners from academia and industry.
+Without these partnerships, this project would not have been possible.
+Thank you!
+
+![Our partners](https://tuc.cloud/index.php/s/KSdWfX5CnSRpRgQ/download/box_logos.png)

birdnet-0.1.0/Pipfile

@@ -0,0 +1,33 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+birdnet = {editable = true, path = "."}
+autopep8 = "*"
+pylint = "*"
+pycodestyle = "*"
+isort = "*"
+rope = "*"
+pytest = "*"
+autoflake = "*"
+twine = "*"
+build = "*"
+mypy = "*"
+pandas-stubs = "*"
+types-tqdm = "*"
+types-requests = "*"
+
+[packages]
+librosa = ">=0.10.0, <1.0.0"
+tensorflow = "==2.15.1"
+resampy = ">=0.4.3, <1.0.0"
+soundfile = ">=0.12.1, <1.0.0"
+scipy = ">=1.9.3, <2.0.0"
+ordered-set = ">=4.1.0, <5.0.0"
+tqdm = ">=4.64.1, <5.0.0"
+numpy = ">=1.23.5, <2.0.0"
+
+[requires]
+python_version = "3.11"