MERIDIAN Python package for ocean ambient noise modelling
Welcome to Kadlu, a Python package for modelling ocean ambient noise
Kadlu was developed for the purpose of modelling noise due to waves and rain in shallow coastal waters, but contains tools useful for many other underwater sound modelling tasks.
Kadlu is written in Python and utilizes a number of powerful software packages including NumPy, HDF5, NetCDF-4, and SQLite. It is licensed under the GNU GPLv3 license and hence freely available for anyone to use and modify. The project is hosted on GitLab at https://git-dev.cs.dal.ca/meridian/kadlu. Kadlu was developed by the MERIDIAN Data Analytics Team at the Institute for Big Data Analytics at Dalhousie University with the support and assistance of David Barclay and Calder Robinson, both from the Department of Oceanography at Dalhousie University.
Kadlu provides functionalities that automate the process of fetching and interpolating environmental data necessary to model ocean ambient noise levels (bathymetry, water temperature and salinity, wave height, wind speed, etc.). It also includes various routines that allow accurate estimates of noise source levels and transmission losses in realistic ocean environments. You can find more information about the technical aspects of how sound propagation is modelled in Kadlu in this note.
The intended users of Kadlu are researchers and students in underwater acoustics working with ambient noise modeling. While Kadlu comes with complete documentation and comprehensive step-by-step tutorials, some familiarity with Python and especially the NumPy package would be beneficial. A basic understanding of the physical principles of underwater sound propagation would also be an advantage.
For more information, please consult Kadlu's Documentation Page.
Kadlu runs on the most recent stable version of Python 3.
ensure that GCC is installed. On Ubuntu, this can be done by installing the build-essential package if its not installed already
sudo apt update sudo apt install build-essential
Install Kadlu using pip
python -m pip install kadlu
Optionally set the storage directory
Kadlu allows configuration for where data is stored on your machine. By default, a folder 'kadlu_data' will be created in the home directory. To specify a custom location, run the following:
import kadlu kadlu.storage_cfg(setdir='/specify/desired/path/here/')
Optionally add an API token for fetching ERA5 data
Configure Kadlu to use the token by executing:
Jupyter notebook tutorials
- gsw Python package (Python implementation of the Thermodynamic Equation of Seawater 2010)
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.