Data

Tools

Indexes

Applications

Experiments

Open Source Science

soundscapy

A python library for soundscape assessments

https://github.com/mitchellacoustics/soundscapy

Science Score: 67.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 7 DOI reference(s) in README
  • ○
    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.3%) to scientific vocabulary

Keywords from Contributors

tide
Last synced: 6 months ago · JSON representation ·

Repository

A python library for soundscape assessments

Basic Info
Statistics
  • Stars: 50
  • Watchers: 4
  • Forks: 9
  • Open Issues: 18
  • Releases: 0
Created about 5 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

Soundscapy Logo <!-- markdownlint-disable-line MD041 -->

Soundscapy

PyPI version Tests Documentation Status License

A python library for analysing and visualising soundscape assessments.

Disclaimer: This module is still heavily in development, and might break what you're working on. It will also likely require a decent amount of troubleshooting at this stage. I promise bug fixes and cleaning up is coming!

Installation

Soundscapy can be installed with pip:

bash pip install soundscapy

Optional Dependencies

Soundscapy splits its functionality into optional modules to reduce the number of dependencies required for basic functionality. By default, Soundscapy includes the survey data processing and plotting functionality.

If you would like to use the binaural audio processing and psychoacoustics functionality, you will need to install the optional audio dependency:

bash pip install "soundscapy[audio]"

To install all optional dependencies, use the following command:

bash pip install "soundscapy[all]"

Examples

We are currently working on writing more comprehensive examples and documentation, please bear with us in the meantime.

Tutorials for using Soundscapy can be found in the documentation.

Acknowledgements

The newly added Binaural analysis functionality relies directly on three acoustic analysis libraries:

  • Acoustic Toolbox for the standard environmental and building acoustics metrics,
  • scikit-maad for the bioacoustics and ecological soundscape metrics, and
  • MoSQITo for the psychoacoustics metrics. We thank each of these packages for their great work in making advanced acoustic analysis more accessible.

Citation

If you are using Soundscapy in your research, please help our scientific visibility by citing our work! Please include a citation to our accompanying paper:

Mitchell, A., Aletta, F., & Kang, J. (2022). How to analyse and represent quantitative soundscape data. JASA Express Letters, 2, 37201. https://doi.org/10.1121/10.0009794

Development Plans

As noted, this package is in heavy development to make it more useable, more stable, and to add features and improvements. At this stage it is mostly limited to doing basic quality checks of soundscape survey data and creating the soundscape distribution plots. Some planned improvements are:

  • [x] Simplify the plotting options
  • [x] Possibly improve how the plots and data are handled - a more OOP approach would be good.
  • [x] Add appropriate tests and documentation.
  • [ ] Bug fixes, ~~particularly around setting color palettes.~~

Large planned feature additions are:

  • [ ] Add better methods for cleaning datasets, including robust outlier exclusion and imputation.
  • [x] Add handling of .wav files.
  • [x] Integrate environmental acoustic and psychoacoustic batch processing. This will involve using existing packages (e.g. MoSQito, python-acoustics) to do the metric calculations, but adding useful functionality for processing any files at once, tieing them to a specific survey response, and implementing a configuration file for maintaining consistent analysis settings.
  • [ ] Integrate the predictive modelling results from the SSID team's research to enable a single pipelined from recording -> psychoacoustics -> predicted soundscape perception (this is very much a pie-in-the-sky future plan, which may not be possible).

Contributing

If you would like to contribute or if you have any bugs you have found while using `Soundscapy', please feel free to get in touch or submit an issue or pull request!

Please see CONTRIBUTING.md for contribution guidelines.

Owner

  • Name: Andrew Mitchell
  • Login: MitchellAcoustics
  • Kind: user
  • Location: London, UK
  • Company: University College London

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Soundscapy
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Andrew
    family-names: Mitchell
    email: a.j.mitchell@ucl.ac.uk
    affiliation: University College London
    orcid: "https://orcid.org/0000-0003-0978-5046"
repository-code: "https://github.com/MitchellAcoustics/Soundscapy"
url: "https://soundscapy.readthedocs.io/en/latest/"
repository: "https://pypi.org/project/soundscapy/"
keywords:
  - soundscape
  - acoustics
  - psychoacoustics
license: BSD-3-Clause
version: 0.7.4
date-released: "2024-10-17"
# preferred-citation:
#   type: article
#   authors:
#   - family-names: "Mitchell"
#     given-names: "Andrew"
#     orcid: "https://orcid.org/0000-0003-0978-5046"
#   - family-names: "Aletta"
#     given-names: "Francesco"
#     orcid: "https://orcid.org/0000-0003-0978-5046"
#   - family-names: "Kang"
#     given-names: "Jian"
#     orcid: "https://orcid.org/0000-0001-8995-5636"
#   doi: "10.1121/10.0009794"
#   journal: "JASA Express Letters"
#   title: "How to analyse and represent quantitative soundscape data"
#   year: 2022

GitHub Events

Total
  • Create event: 57
  • Release event: 13
  • Issues event: 23
  • Watch event: 11
  • Delete event: 22
  • Member event: 1
  • Issue comment event: 20
  • Push event: 194
  • Pull request review event: 2
  • Pull request event: 34
  • Fork event: 1
Last Year
  • Create event: 57
  • Release event: 13
  • Issues event: 23
  • Watch event: 11
  • Delete event: 22
  • Member event: 1
  • Issue comment event: 20
  • Push event: 194
  • Pull request review event: 2
  • Pull request event: 34
  • Fork event: 1

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 476
  • Total Committers: 4
  • Avg Commits per committer: 119.0
  • Development Distribution Score (DDS): 0.008
Past Year
  • Commits: 174
  • Committers: 1
  • Avg Commits per committer: 174.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Andrew Mitchell m****5@g****m 472
Sourcery AI 2
sourcery-ai[bot] 5****] 1
Watson310N n****7@u****k 1
Committer Domains (Top 20 + Academic)
ucl.ac.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 42
  • Total pull requests: 87
  • Average time to close issues: 4 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 7
  • Total pull request authors: 2
  • Average comments per issue: 0.74
  • Average comments per pull request: 0.69
  • Merged pull requests: 65
  • Bot issues: 0
  • Bot pull requests: 7
Past Year
  • Issues: 19
  • Pull requests: 29
  • Average time to close issues: 3 months
  • Average time to close pull requests: 1 day
  • Issue authors: 5
  • Pull request authors: 1
  • Average comments per issue: 0.79
  • Average comments per pull request: 0.38
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • MitchellAcoustics (34)
  • balandinodidonato (2)
  • X-Fan-Jack (2)
  • auraacustica (1)
  • karnwatcharasupat (1)
  • olivier8064 (1)
  • JuanTejedor (1)
Pull Request Authors
  • MitchellAcoustics (90)
  • sourcery-ai[bot] (7)
Top Labels
Issue Labels
enhancement (14) bug (13) documentation (2) question (1) good first issue (1) pre-commit (1) internals (1) dependencies (1)
Pull Request Labels
enhancement (10) bug (6) documentation (3) dependencies (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 183 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 2
  • Total versions: 37
  • Total maintainers: 1
pypi.org: soundscapy

A python library for analysing and visualising soundscape assessments.

  • Versions: 37
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 183 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 11.5%
Forks count: 11.9%
Stargazers count: 12.1%
Average: 12.1%
Downloads: 14.9%
Maintainers (1)
MitchellAcoustics
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
  • black ^22.6.0 develop
  • jupyter ^1.0.0
  • matplotlib ^3.5.2
  • numpy >1.21.0 <1.23.0
  • openpyxl ^3.0.10
  • pandas ^1.4.3
  • pandas-flavor ^0.3.0
  • pyjanitor ^0.23.1
  • python ^3.8
  • seaborn ^0.11.2
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • eifinger/setup-rye v4.2.3 composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • eifinger/setup-rye v4.2.3 composite
.github/workflows/test-release.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v2 composite
  • eifinger/setup-rye v4.2.3 composite