https://github.com/org-arl/arlpy
ARL Python Tools
https://github.com/org-arl/arlpy
acoustics communications gps plotting python signal-processing underwater unet utils
Last synced: 29 days ago
JSON representation
ARL Python Tools
- Host: GitHub
- URL: https://github.com/org-arl/arlpy
- Owner: org-arl
- License: bsd-3-clause
- Created: 2016-08-03T17:08:13.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T16:06:07.000Z (7 months ago)
- Last Synced: 2025-04-19T13:04:42.392Z (about 2 months ago)
- Topics: acoustics, communications, gps, plotting, python, signal-processing, underwater, unet, utils
- Language: Python
- Size: 9.15 MB
- Stars: 129
- Watchers: 16
- Forks: 38
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ARL Python Tools
[](https://github.com/org-arl/arlpy/actions)
Packages such as `numpy` and `scipy` provide excellent mathematical tools for
scientists and engineers using Python. However, these packages are still young
and evolving, and understandably have some gaps, especially when it comes to
domain-specific requirements. The `arlpy` package aims to fill in some of the
gaps in the areas of underwater acoustics, signal processing, and communication.
Additionally, `arlpy` also includes some commonly needed utilities and plotting
routines based on `bokeh`.
## General modules
The following modules are general and are likely to be of interest to researchers
and developers working on signal processing, communication and underwater acoustics:
* Signal processing (`arlpy.signal`)
* Communications (`arlpy.comms`)
* Beamforming and array processing (`arlpy.bf`)
* Stable distributions (`arlpy.stable`)
* Geographical coordinates (`arlpy.geo`)
* Underwater acoustics (`arlpy.uwa`)
* Underwater acoustic propagation modeling (`arlpy.uwapm`)
* Plotting utilities (`arlpy.plot`)
* Common utilities (`arlpy.utils`)
## Special-purpose modules
The following modules are specific to tools available at the ARL and may not be of
general interest to others:
* Digital Towed Array (`arlpy.dtla`)
* ROMANIS (`arlpy.romanis`)
* HiDAQ (`arlpy.hidaq`)
* UNET (`arlpy.unet`)
## Usage
Installation::
```
pip install arlpy
```
To import all general modules::
```
import arlpy
```
## Notes
Png export of bokeh plots requires `selenium`, `pillow` and `phantomjs`. These are not
installed as automatic depdendencies, since they are optional and only required
for png export. These should be installed manually, if desired.
## Useful links
* [arlpy home](https://github.com/org-arl/arlpy)
* [arlpy documentation](https://arlpy.readthedocs.io/en/latest/)