beamshapes
beamshapes: a Python package to generate directivity patterns for various sound source models - Published in JOSS (2022)
Science Score: 59.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
Found 6 DOI reference(s) in README -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
2 of 4 committers (50.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.7%) to scientific vocabulary
Keywords
Scientific Fields
Repository
Directivity functions for various sound sources
Basic Info
Statistics
- Stars: 5
- Watchers: 1
- Forks: 4
- Open Issues: 0
- Releases: 1
Topics
Metadata Files
README.md
Beamshapes
Calculate directivity of various sound source models and get their beamshapes.
This package is released under an MIT license.
Getting started with beamshapes
```
import matplotlib.pyplot as plt import numpy as np import beamshapes from beamshapes import pistonininfinitebaffledirectivity as PIB # short alias inputparameters = {'k':50, 'a':0.1} angles = np.linspace(-np.pi/2,np.pi/2,50) _, directionality = PIB(angles, inputparameters) # output the dB(D(theta)/D(on-axis)) plt.figure();a0 = plt.subplot(111, projection='polar') plt.plot(angles, directionality) # plot the beamshape !! ```
For more detailed use-cases, check out the example gallery online!
Installation
PyPi installation (>=version 0.2.1)
pip install beamshapes
Local installation instructions For the steps below to work you need to have a working Python installation that you can access from the command line. It is recommended to do the installation in a virtual environment.
- Clone the Github repository
git clone https://github.com/thejasvibr/bat_beamshapes.git - Change directories to the downloaded repo, and switch to the dev branch:
git checkout dev - Install the dependencies with
pip install -r beamshapes/tests/requirements_test.txt - Install beamshapes with
python setup.py install
Detailed documentation
For more details on the concepts and source documentation - please check out the online docs.
Citation information
If you use this package - please cite the paper:
APA-style format
Beleyur, T., (2022). beamshapes: a Python package to generate directivity patterns for various sound source models. Journal of Open Source Software, 7(69), 3740, https://doi.org/10.21105/joss.03740
Bibtext format:
@article{Beleyur2022,
doi = {10.21105/joss.03740},
url = {https://doi.org/10.21105/joss.03740},
year = {2022},
publisher = {The Open Journal},
volume = {7},
number = {69},
pages = {3740},
author = {Thejasvi Beleyur},
title = {beamshapes: a Python package to generate directivity patterns for various sound source models},
journal = {Journal of Open Source Software}
}
If possible, and space allows also do mention the package version (e.g. beamshapes 0.2.X) .
You can access the version number of the package being used with
```
import beamshapes print(beamshapes.version) ```
Change log
v0.2.3 : unify the keyword arguments across the flint and mpmath piston in a sphere implementations. Both implementations now use NN to define matrix size, and n_cores to set number of CPUs to use.
Future implementations
- Piston on a cylinder
- Rectangular piston on a prolate spheroid (paper)
Owner
- Name: Thejasvi Beleyur
- Login: thejasvibr
- Kind: user
- Company: Centre for the Advanced Study of Collective Behaviour
- Website: https://thejasvibr.github.io/
- Twitter: thejasvibr
- Repositories: 7
- Profile: https://github.com/thejasvibr
Mics, Camera, Echolocation!
GitHub Events
Total
Last Year
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| thejasvi | t****b@g****m | 118 |
| tbeleyur | t****r@o****e | 105 |
| Fabian-Robert Stöter | f****t | 1 |
| Daniel S. Katz | d****z@i****g | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 23
- Total pull requests: 2
- Average time to close issues: 2 months
- Average time to close pull requests: about 13 hours
- Total issue authors: 4
- Total pull request authors: 2
- Average comments per issue: 2.87
- Average comments per pull request: 0.5
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- hagenw (13)
- nils-werner (8)
- faroit (1)
- thejasvibr (1)
Pull Request Authors
- faroit (1)
- danielskatz (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 16 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 1
- Total maintainers: 1
pypi.org: beamshapes
Acoustic beamshape modelling for various sources
- Homepage: https://github.com/thejasvibr/bat_beamshapes.git
- Documentation: https://beamshapes.readthedocs.io/
- License: MIT
-
Latest release: 0.2.1
published over 4 years ago
Rankings
Maintainers (1)
Dependencies
- joblib * test
- matplotlib * test
- mpmath * test
- numpy >=1.17 test
- pandas * test
- scipy * test
- sympy * test
- tqdm * test
- joblib *
- matplotlib *
- mpmath *
- numpy *
- pandas *
- recommonmark *
- scipy *
- sphinx ==4.2.0
- sphinx_gallery ==0.8.2
- sphinx_rtd_theme *
- sympy *
- tqdm *
- joblib *
- matplotlib *
- mpmath *
- numpy *
- scipy *
- sympy *
- tqdm *