fishsound-finder


Namefishsound-finder JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/xaviermouy/FishSound_Finder
SummaryPython software to automatically detect fish sounds in passive acoustic recordings
upload_time2024-03-27 05:25:18
maintainerNone
docs_urlNone
authorXavier Mouy
requires_python<3.10.0,>=3.9.0
licenseBSD license
keywords fish sounds
VCS
bugtrack_url
requirements ketos ecosound silence_tensorflow
Travis-CI No Travis.
coveralls test coverage No coveralls.
            

.. image:: docs/source/_static/fishsound_finder_logo_long_smaller.png


Welcome to FishSound Finder!
============================================

**FishSound Finder** is an open source python software to automatically detect and classify fish sounds in 
passive acoustic recordings. It is based on the python libraries `ecosound <https://ecosound.readthedocs.io/en/latest/>`_ and `ketos <https://docs.meridian.cs.dal.ca/ketos/>`_.
FishSound Finder was trained to detect isolated grunts and knocks produced by fish (not choruses). It was originally developed to analyze fish sounds from British Columbia (Canada) but proved to work well also in other parts of the world (e.g. Florida, USA).
Future versions will also include detectors for specific fish species (e.g. haddock). Detection outputs from FishSound Finder
are compatible with the popular bioacoustics software `Raven <https://ravensoundsoftware.com/>`_.

.. image:: docs/source/_static/detection_example.png


Documentation
-------------
The documentation of FishSound Finder can be found here: https://fishsound-finder.readthedocs.io. It includes a description of the software,
instructions on how to install and run it, as well as a tutorial.


Contributors
------------

Lead developper:

* `Xavier Mouy <https://xaviermouy.weebly.com/>`_

Collaborators:

* Dana Haggarty

* Francis Juanes

* `Stephanie Archer <https://lumcon.edu/stephanie-archer/>`_

* `Philina English <https://ecophilina.wordpress.com/>`_

* Sarah Dudas

* Darienne Lancaster


Analysts :


* Cierra Hart

* Courtney Evans

* Emie Woodburn

* Erik Archer 


Credits
-------

* The FishSound Finder logo uses the rockfish image from `freepik.com <https://www.freepik.com/free-icon/rockfish-shape_718051.htm#page=1&query=rockfish%20shape&position=0>`_

* This project was initiated in the `Juanes Lab <https://juaneslab.weebly.com/>`_ at the University of Victoria (British Columbia, Canada) and received funding from the `Canadian Healthy Oceans Network <https://chone2.ca/>`_ and `Fisheries and Oceans Canada - Pacific Region <https://www.dfo-mpo.gc.ca/contact/regions/pacific-pacifique-eng.html#Nanaimo-Lab>`_. 


License
-------
FishSound Finder is licensed under the open source `BSD-3-Clause License <https://choosealicense.com/licenses/bsd-3-clause/>`_.



=======
History
=======

0.0.0 (2020-12-01)
------------------

* First test.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/xaviermouy/FishSound_Finder",
    "name": "fishsound-finder",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.10.0,>=3.9.0",
    "maintainer_email": null,
    "keywords": "fish sounds",
    "author": "Xavier Mouy",
    "author_email": "xaviermouy@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/58/1a/20c77b4785c109852897b3e56d915bb3b29976e2e42cea01fe03caa1989e/fishsound_finder-0.1.0.tar.gz",
    "platform": null,
    "description": "\r\n\r\n.. image:: docs/source/_static/fishsound_finder_logo_long_smaller.png\r\n\r\n\r\nWelcome to FishSound Finder!\r\n============================================\r\n\r\n**FishSound Finder** is an open source python software to automatically detect and classify fish sounds in \r\npassive acoustic recordings. It is based on the python libraries `ecosound <https://ecosound.readthedocs.io/en/latest/>`_ and `ketos <https://docs.meridian.cs.dal.ca/ketos/>`_.\r\nFishSound Finder was trained to detect isolated grunts and knocks produced by fish (not choruses). It was originally developed to analyze fish sounds from British Columbia (Canada) but proved to work well also in other parts of the world (e.g. Florida, USA).\r\nFuture versions will also include detectors for specific fish species (e.g. haddock). Detection outputs from FishSound Finder\r\nare compatible with the popular bioacoustics software `Raven <https://ravensoundsoftware.com/>`_.\r\n\r\n.. image:: docs/source/_static/detection_example.png\r\n\r\n\r\nDocumentation\r\n-------------\r\nThe documentation of FishSound Finder can be found here: https://fishsound-finder.readthedocs.io. It includes a description of the software,\r\ninstructions on how to install and run it, as well as a tutorial.\r\n\r\n\r\nContributors\r\n------------\r\n\r\nLead developper:\r\n\r\n* `Xavier Mouy <https://xaviermouy.weebly.com/>`_\r\n\r\nCollaborators:\r\n\r\n* Dana Haggarty\r\n\r\n* Francis Juanes\r\n\r\n* `Stephanie Archer <https://lumcon.edu/stephanie-archer/>`_\r\n\r\n* `Philina English <https://ecophilina.wordpress.com/>`_\r\n\r\n* Sarah Dudas\r\n\r\n* Darienne Lancaster\r\n\r\n\r\nAnalysts :\r\n\r\n\r\n* Cierra Hart\r\n\r\n* Courtney Evans\r\n\r\n* Emie Woodburn\r\n\r\n* Erik Archer \r\n\r\n\r\nCredits\r\n-------\r\n\r\n* The FishSound Finder logo uses the rockfish image from `freepik.com <https://www.freepik.com/free-icon/rockfish-shape_718051.htm#page=1&query=rockfish%20shape&position=0>`_\r\n\r\n* This project was initiated in the `Juanes Lab <https://juaneslab.weebly.com/>`_ at the University of Victoria (British Columbia, Canada) and received funding from the `Canadian Healthy Oceans Network <https://chone2.ca/>`_ and `Fisheries and Oceans Canada - Pacific Region <https://www.dfo-mpo.gc.ca/contact/regions/pacific-pacifique-eng.html#Nanaimo-Lab>`_. \r\n\r\n\r\nLicense\r\n-------\r\nFishSound Finder is licensed under the open source `BSD-3-Clause License <https://choosealicense.com/licenses/bsd-3-clause/>`_.\r\n\r\n\r\n\r\n=======\r\nHistory\r\n=======\r\n\r\n0.0.0 (2020-12-01)\r\n------------------\r\n\r\n* First test.\r\n",
    "bugtrack_url": null,
    "license": "BSD license",
    "summary": "Python software to automatically detect fish sounds in passive acoustic recordings",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/xaviermouy/FishSound_Finder"
    },
    "split_keywords": [
        "fish",
        "sounds"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "469b04e04d55a511c61b7e45501a69e3a519149d0fc67384c1653966515a212b",
                "md5": "4d3370830a1f47e0817614e14f20455f",
                "sha256": "3c168446acd447a0959548ad322cd9e26b006b7718b1f5ffa82d35304352d362"
            },
            "downloads": -1,
            "filename": "fishsound_finder-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4d3370830a1f47e0817614e14f20455f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.10.0,>=3.9.0",
            "size": 10291,
            "upload_time": "2024-03-27T05:25:16",
            "upload_time_iso_8601": "2024-03-27T05:25:16.435309Z",
            "url": "https://files.pythonhosted.org/packages/46/9b/04e04d55a511c61b7e45501a69e3a519149d0fc67384c1653966515a212b/fishsound_finder-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "581a20c77b4785c109852897b3e56d915bb3b29976e2e42cea01fe03caa1989e",
                "md5": "6985ffb245649254444d87cc309a46b6",
                "sha256": "28789cc9843c8deb2f47005a5f38620a00a3a03845c2861b366460132ae6e279"
            },
            "downloads": -1,
            "filename": "fishsound_finder-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6985ffb245649254444d87cc309a46b6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.10.0,>=3.9.0",
            "size": 11344,
            "upload_time": "2024-03-27T05:25:18",
            "upload_time_iso_8601": "2024-03-27T05:25:18.004077Z",
            "url": "https://files.pythonhosted.org/packages/58/1a/20c77b4785c109852897b3e56d915bb3b29976e2e42cea01fe03caa1989e/fishsound_finder-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-27 05:25:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "xaviermouy",
    "github_project": "FishSound_Finder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "ketos",
            "specs": [
                [
                    "==",
                    "2.6.2"
                ]
            ]
        },
        {
            "name": "ecosound",
            "specs": [
                [
                    "==",
                    "0.0.25"
                ]
            ]
        },
        {
            "name": "silence_tensorflow",
            "specs": []
        }
    ],
    "lcname": "fishsound-finder"
}
        
Elapsed time: 0.24673s