{"id":16500089,"url":"https://github.com/gbeckers/birdwatcher","last_synced_at":"2025-10-13T09:14:11.159Z","repository":{"id":33279642,"uuid":"156536373","full_name":"gbeckers/Birdwatcher","owner":"gbeckers","description":"A Python computer vision library for animal behavior","archived":false,"fork":false,"pushed_at":"2024-11-26T12:38:26.000Z","size":76549,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-01T09:31:13.214Z","etag":null,"topics":["animal","behavior","computer-vision","data-science","ffmpeg","opencv","python","science"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gbeckers.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-11-07T11:28:06.000Z","updated_at":"2024-01-31T08:11:00.000Z","dependencies_parsed_at":"2024-04-04T08:37:17.442Z","dependency_job_id":null,"html_url":"https://github.com/gbeckers/Birdwatcher","commit_stats":{"total_commits":397,"total_committers":4,"mean_commits":99.25,"dds":"0.22418136020151136","last_synced_commit":"cbdc367111ec345cb7602ddf65ad0ab43ef610ca"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbeckers%2FBirdwatcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbeckers%2FBirdwatcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbeckers%2FBirdwatcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbeckers%2FBirdwatcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gbeckers","download_url":"https://codeload.github.com/gbeckers/Birdwatcher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238574738,"owners_count":19494723,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animal","behavior","computer-vision","data-science","ffmpeg","opencv","python","science"],"created_at":"2024-10-11T14:55:40.648Z","updated_at":"2025-10-13T09:14:03.197Z","avatar_url":"https://github.com/gbeckers.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Birdwatcher\n===========\n\n|Github CI Status| |PyPi version| |Docs Status| |Repo Status|\n|Codecov status|\n\n.. image:: docs/images/banner.gif\n  :align: center\n  :width: 720\n\nBirdwatcher is a Python computer vision library for analyzing animal behavior in a Python scientific computing environment.\n\nBirdwatcher should help you getting up and running quickly when building analysis code or tools for specific measurements. It provides functionality that is common in video analysis, such as reading and writing videos into and from numpy arrays, applying processing algorithms such as background subtraction, morphological transformation, resizing, drawing on frames etc. Much of the underlying video and image processing is based on `FFmpeg \u003chttps://www.ffmpeg.org/\u003e`__ and `OpenCV \u003chttps://opencv.org/\u003e`__, but Birdwatcher is easier to use for many tasks because its higher-level implementation of functionality.\n\nIn addition to video analysis tools, Birdwatcher has high-level functions for behavioral analysis based on such tools, although currently these are limited to movement/location detection of single animals.\n\nDespite its name, Birdwatcher is not only for birds. We also successfully analyzed dog behavior, and it could be used on anything that moves. It is being used in our lab but still under heavy development, and should be considered alpha software.\n\nCode can be found on GitHub: https://github.com/gbeckers/Birdwatcher .\n\nDocumentation can be found at https://birdwatcher.readthedocs.io .\n\nIt is developed by Gabriel Beckers and Carien Mol, at Experimental Psychology,\nUtrecht University. It is open source, freely available under the `New BSD License\n\u003chttps://opensource.org/licenses/BSD-3-Clause\u003e`__ terms.\n\n\nInstallation Birdwatcher package\n--------------------------------\n\nBirdwatcher officially supports Python 3.9 or higher, but older\nPython 3 versions may also work.\n\n**User installation**\n\n#. We recommend using Anaconda for installation. Install Anaconda from https://www.anaconda.com/ .\n\n#. Open Anaconda prompt in terminal.\n\n#. Create new environment for Birdwatcher (name is up to you, in example here 'mybirdwatcher'). We install Jupyter lab and ffmpeg at the same time:\n\n    .. code-block:: bash\n\n      $ conda create -n mybirdwatcher python=3.9 jupyterlab ffmpeg git\n\n#. Switch to this new environment:\n\n   Linux and MacOS:\n\n    .. code-block:: bash\n\n      $ source activate mybirdwatcher\n\n   Windows:\n\n    .. code-block:: bash\n\n      $ conda activate mybirdwatcher\n\n#. Install Birdwatcher:\n\n   Stable latest official release from PyPi:\n\n    .. code-block:: bash\n\n      $ pip install Birdwatcher\n\n   If instead you want the latest version of the git master branch from, use:\n\n    .. code-block:: bash\n\n      $ pip install git+https://github.com/gbeckers/birdwatcher@master\n\n\n**Dependencies**\n\nThe following dependencies are automatically taken care of when you\ninstall Birdwatcher using the pip method above:\n\n- numpy\n- pandas\n- matplotlib\n- seaborn\n- darr\n- opencv-python\n- opencv-contrib-python\n\nIt further depends on:\n\n- ffmpeg (including ffprobe)\n\nIf you do not use the conda way above to install ffmpeg, you need to\ninstall it yourself (https://www.ffmpeg.org/).\n\n\nRun notebooks tutorial\n----------------------\n\nTo quickly learn the fundamentals of Birdwatcher, please walk through our notebooks. First, you need to download the notebooks and example videos from github. Then, navigate to the directory of the notebooks and activate the 'mybirdwatcher' environment. Type `jupyter lab` which opens in your browser. You can now open the notebooks and run the tutorial.\n\n\nTest\n----\n\nTo run the test suite:\n\n.. code:: python\n\n    \u003e\u003e\u003eimport birdwatcher as bw\n    \u003e\u003e\u003ebw.test()\n    ..................................................\n    ----------------------------------------------------------------------\n    Ran 50 tests in 75.858s\n\n    OK\n    \n    \u003cunittest.runner.TextTestResult run=50 errors=0 failures=0\u003e\n\n\nDocumentation\n-------------\n\nhttps://birdwatcher.readthedocs.io\n\nExamples\n--------\n\nSee `jupyter notebook directory\n\u003chttps://github .com/gbeckers/Birdwatcher/tree/master/notebooks\u003e`__.\n\nContributions\n-------------\nSita ter Haar and Dylan Minekus helped exploring the application of movement\ndetection algorithms.\n\n.. |Repo Status| image:: https://www.repostatus.org/badges/latest/active.svg\n   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.\n   :target: https://www.repostatus.org/#active\n.. |Github CI Status| image:: https://github.com/gbeckers/Birdwatcher/actions/workflows/python_package.yml/badge.svg\n   :target: https://github.com/gbeckers/Birdwatcher/actions/workflows/python_package.yml\n.. |PyPi version| image:: https://img.shields.io/badge/pypi-0.4.0-orange.svg\n   :target: https://pypi.org/project/birdwatcher/\n.. |Docs Status| image:: https://readthedocs.org/projects/birdwatcher/badge/?version=latest\n   :target: https://birdwatcher.readthedocs.io/en/latest/\n.. |Codecov status| image:: https://codecov.io/gh/gbeckers/Birdwatcher/branch/master/graph/badge.svg?token=829BH0NSVM\n   :target: https://codecov.io/gh/gbeckers/Birdwatcher\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbeckers%2Fbirdwatcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgbeckers%2Fbirdwatcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbeckers%2Fbirdwatcher/lists"}