PyPAM based Processing
Project description
PyPAM based data processing
The mbari-pbp package allows to process ocean audio data archives to daily analysis products of hybrid millidecade spectra using PyPAM.
Status: Functional version, including support for cloud based processing.
- JSON generation of timekeeping with indication of start and duration of recognized sound files
- Audio file processing
- Frequency and psd array output
- Concatenation of processed 1-minute segments for daily product
- Calibration with given sensitivity file (NetCDF), or flat sensitivity value
- Data products
- NetCDF with metadata
- Summary plot
- Cloud processing
- Inputs can be downloaded from and uploaded to S3
- Inputs can be downloaded from public GCS bucket
- Outputs can be uploaded to GCS
Documentation
Installation
The only requirement is Python 3.9, 3.10, or 3.11 on your environment.[^1]
You can run python3 --version
to check the version of Python installed.
[^1]: As currently required by PyPAM.
As a general practice, it is recommended to use a virtual environment for the installation.
python3.11 -m venv virtenv
source virtenv/bin/activate
Install the package:
pip install mbari-pbp
Programs and API
The mbari-pbp package includes command line interface (CLI) programs, and also provides APIs you can use in your Python scripts or notebooks.
CLI Programs
The package includes the following CLI programs:
Program | Description |
---|---|
pbp-meta-gen |
Generate JSON files with audio metadata. |
pbp |
Main HMB generation program. |
pbp-cloud |
Program for cloud based processing. |
pbp-plot |
Utility program to plot resulting HMB product. |
API
TODO link to the API documentation.
References
- PyPAM - Python tool for Passive Acoustic Monitoring – https://doi.org/10.5281/zenodo.6044593
- Computation of single-sided mean-square sound pressure spectral density with 1 Hz resolution follows ISO 18405 3.1.3.13 (International Standard ISO 18405:2017(E), Underwater Acoustics – Terminology. Geneva: ISO) – https://www.iso.org/standard/62406.html
- Hybrid millidecade spectra: A practical format for exchange of long-term ambient sound data – https://asa.scitation.org/doi/10.1121/10.0003324
- Erratum: Hybrid millidecade spectra – https://asa.scitation.org/doi/10.1121/10.0005818
Development
See DEVELOPMENT.md for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mbari_pbp-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1b85e7687ea1282362bf640d4dac237dd91819cc64ec23857abf1ea7c47f4a8 |
|
MD5 | cf7023c93911b99f9ac1564785d6cdf2 |
|
BLAKE2b-256 | 5f66cd65f73b8700deca744e9010be01ace9d1606b891efb81a305950ae443ab |