guano

Python reference implementation of the GUANO bat acoustics metadata specification

https://github.com/riggsd/guano-py

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 4 committers (25.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary

Keywords

anabat bat-acoustics bat-detector bats guano metadata

Last synced: 6 months ago · JSON representation

Repository

Python reference implementation of the GUANO bat acoustics metadata specification

Basic Info

Host: GitHub
Owner: riggsd
License: mit
Language: Python
Default Branch: master
Homepage: http://guano-md.org
Size: 175 KB

Statistics

Stars: 18
Watchers: 5
Forks: 5
Open Issues: 8
Releases: 0

Topics

anabat bat-acoustics bat-detector bats guano metadata

Created over 10 years ago · Last pushed 12 months ago

Metadata Files

Readme License

README.rst

guano-py
========

This is the `Python`_ reference implementation for `GUANO`_, the “Grand
Unified Acoustic Notation Ontology”, a metadata format for bat acoustics
recordings. It includes a production-ready Python module with full
support for reading and writing GUANO metadata, as well as several
helpful commandline utilities.

For more information about GUANO metadata itself, including the format
specification, see the GUANO project homepage: http://guano-md.org

Documentation for guano-py can be found at: http://guano-py.readthedocs.io


Requirements
============

- Python 3.6+


Installation
============

Download and install magically from the Python Package Index::

    $> pip install -U guano

In addition to having the ``guano`` Python module available for use in
your own software, you’ll also have a small collection of `useful
scripts`_ to use.

Alternately, you can check out the project from GitHub and install
locally in developer mode to hack on it yourself::

    $> git clone https://github.com/riggsd/guano-py.git
    $> cd guano-py
    $> python setup.py develop

Master:|Master Tests| Dev:|Dev Tests| |Documentation Status|


API Usage
=========

.. code:: python

    from guano import GuanoFile

    # load a .WAV file with (or without) GUANO metadata
    g = GuanoFile('test.wav')

    # get and set metadata values like a Python dict
    print g['GUANO|Version']
    >>> 1.0

    print g['Make'], g['Model']
    >>> 'Pettersson', 'D500X'

    g['Species Manual ID'] = 'Myso'

    g['Note'] = 'I love GUANO!'

    # namespaced fields can be specified separately or pipe-delimited
    print g['PET', 'Gain'], g['PET|Gain']
    >>> 80, 80

    g['SB|Consensus'] = 'Epfu'
    g['SB', 'Consensus'] = 'Epfu'

    # print all the metadata values
    for key, value in g.items():
        print '%s: %s' % (key, value)

    # write the updated .WAV file back to disk
    g.write()

    # have some GUANO metadata from some other source? load it from a string
    g = GuanoFile.from_string('GUANO|Version:1.0\nTags:voucher,hand-release')

    # write GUANO metadata somewhere else, say an Anabat file or text file
    with open('sidecar_file.guano', 'wb') as outfile:
        outfile.write( g.serialize() )

    # teach the parser to recognize custom metadata fields
    GuanoFile.register('Anabat', ['Humidity', 'Temperature'], float)
    GuanoFile.register('SB', 'Thumbnail Image', guano.base64decode)


.. _Python: http://python.org
.. _GUANO: http://guano-md.org
.. _useful scripts: bin/

.. |Master Tests| image:: https://github.com/riggsd/guano-py/actions/workflows/python-tests.yml/badge.svg?branch=master
   :target: https://github.com/riggsd/guano-py/actions/workflows/python-tests.yml?query=branch%3Amaster
.. |Dev Tests| image:: https://github.com/riggsd/guano-py/actions/workflows/python-tests.yml/badge.svg?branch=dev
   :target: https://github.com/riggsd/guano-py/actions/workflows/python-tests.yml?query=branch%3Adev
.. |Documentation Status| image:: https://readthedocs.org/projects/guano-py/badge/?version=latest
   :target: http://guano-py.readthedocs.io/en/latest/?badge=latest

Owner

Name: David A. Riggs
Login: riggsd
Kind: user
Location: Oregon (usually underground)
Company: @nationalparkservice

Repositories: 15
Profile: https://github.com/riggsd

Bats and caves n' stuff.

GitHub Events

Total

Issues event: 4
Watch event: 4
Issue comment event: 5
Push event: 9
Pull request event: 1
Fork event: 1
Create event: 2

Last Year

Issues event: 4
Watch event: 4
Issue comment event: 5
Push event: 9
Pull request event: 1
Fork event: 1
Create event: 2

Committers

Last synced: about 2 years ago

All Time

Total Commits: 101
Total Committers: 4
Avg Commits per committer: 25.25
Development Distribution Score (DDS): 0.198

Past Year

Commits: 5
Committers: 1
Avg Commits per committer: 5.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
David A. Riggs	d**s@m**m	81
David A. Riggs	d**s@g**m	18
Talbert	t**c@u**v	1
Abram Fleishman	a****n	1

Committer Domains (Top 20 + Academic)

usgs.gov: 1 myotisoft.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 27
Total pull requests: 4
Average time to close issues: 9 months
Average time to close pull requests: 3 months
Total issue authors: 12
Total pull request authors: 3
Average comments per issue: 1.7
Average comments per pull request: 1.5
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 3
Pull requests: 2
Average time to close issues: 30 days
Average time to close pull requests: 5 months
Issue authors: 2
Pull request authors: 1
Average comments per issue: 0.33
Average comments per pull request: 3.0
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

riggsd (12)
ColinTalbert (3)
abfleishman (2)
alhirzel (2)
jmears63 (1)
Firefly86 (1)
parsingphase (1)
thorenson (1)
BCTSoundAnal (1)
dijitali (1)
arky (1)
Pete-the-Geek (1)

Pull Request Authors

IamJeffG (2)
ColinTalbert (1)
abfleishman (1)

Top Labels

Issue Labels

specification (6) enhancement (2) bug (2)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 194 last-month

Total dependent packages: 0
Total dependent repositories: 4
Total versions: 15
Total maintainers: 1

pypi.org: guano

GUANO, the "Grand Unified" bat acoustics metadata format

Homepage: https://github.com/riggsd/guano-py
Documentation: https://guano.readthedocs.io/
License: MIT
Latest release: 1.0.16
published 12 months ago

Versions: 15
Dependent Packages: 0
Dependent Repositories: 4
Downloads: 194 Last month

Rankings

Dependent repos count: 7.5%

Dependent packages count: 10.1%

Downloads: 11.3%

Average: 12.4%

Forks count: 15.4%

Stargazers count: 17.7%

Maintainers (1)

driggs

Last synced: 6 months ago

Dependencies

requirements_dev.txt pypi

sphinx * development
twine * development
wheel * development

setup.py pypi

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

guano

Science Score: 36.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: guano

Rankings

Maintainers (1)

Dependencies