# 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/)
Raw data
{
"_id": null,
"home_page": "https://github.com/org-arl/arlpy",
"name": "arlpy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "underwater acoustics signal processing communication",
"author": "Mandar Chitre",
"author_email": "mandar@nus.edu.sg",
"download_url": "https://files.pythonhosted.org/packages/85/e9/2a4a9deb89338f6ca48c926401d18700eff46a0eca3e6df256f2a990eecf/arlpy-1.9.1.tar.gz",
"platform": null,
"description": "# ARL Python Tools\n\n[](https://github.com/org-arl/arlpy/actions)\n\nPackages such as `numpy` and `scipy` provide excellent mathematical tools for\nscientists and engineers using Python. However, these packages are still young\nand evolving, and understandably have some gaps, especially when it comes to\ndomain-specific requirements. The `arlpy` package aims to fill in some of the\ngaps in the areas of underwater acoustics, signal processing, and communication.\nAdditionally, `arlpy` also includes some commonly needed utilities and plotting\nroutines based on `bokeh`.\n\n## General modules\n\nThe following modules are general and are likely to be of interest to researchers\nand developers working on signal processing, communication and underwater acoustics:\n\n* Signal processing (`arlpy.signal`)\n* Communications (`arlpy.comms`)\n* Beamforming and array processing (`arlpy.bf`)\n* Stable distributions (`arlpy.stable`)\n* Geographical coordinates (`arlpy.geo`)\n* Underwater acoustics (`arlpy.uwa`)\n* Underwater acoustic propagation modeling (`arlpy.uwapm`)\n* Plotting utilities (`arlpy.plot`)\n* Common utilities (`arlpy.utils`)\n\n## Special-purpose modules\n\nThe following modules are specific to tools available at the ARL and may not be of\ngeneral interest to others:\n\n* Digital Towed Array (`arlpy.dtla`)\n* ROMANIS (`arlpy.romanis`)\n* HiDAQ (`arlpy.hidaq`)\n* UNET (`arlpy.unet`)\n\n## Usage\n\nInstallation::\n```\npip install arlpy\n```\n\nTo import all general modules::\n```\nimport arlpy\n```\n\n## Notes\n\nPng export of bokeh plots requires `selenium`, `pillow` and `phantomjs`. These are not\ninstalled as automatic depdendencies, since they are optional and only required\nfor png export. These should be installed manually, if desired.\n\n## Useful links\n\n* [arlpy home](https://github.com/org-arl/arlpy)\n* [arlpy documentation](https://arlpy.readthedocs.io/en/latest/)\n\n\n",
"bugtrack_url": null,
"license": "BSD (3-clause)",
"summary": "ARL Python Tools",
"version": "1.9.1",
"project_urls": {
"Homepage": "https://github.com/org-arl/arlpy"
},
"split_keywords": [
"underwater",
"acoustics",
"signal",
"processing",
"communication"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85e92a4a9deb89338f6ca48c926401d18700eff46a0eca3e6df256f2a990eecf",
"md5": "133a66eb1f682b8ddac3a50aa56c2bcb",
"sha256": "98db62383f7e8ad453b3532ebee62d1f050365423fdb85dd3b87a7b6f832d626"
},
"downloads": -1,
"filename": "arlpy-1.9.1.tar.gz",
"has_sig": false,
"md5_digest": "133a66eb1f682b8ddac3a50aa56c2bcb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 45359,
"upload_time": "2024-11-25T16:07:14",
"upload_time_iso_8601": "2024-11-25T16:07:14.272426Z",
"url": "https://files.pythonhosted.org/packages/85/e9/2a4a9deb89338f6ca48c926401d18700eff46a0eca3e6df256f2a990eecf/arlpy-1.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 16:07:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "org-arl",
"github_project": "arlpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.24.0"
]
]
},
{
"name": "numpy",
"specs": [
[
"<",
"2.0.0"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.13.0"
]
]
},
{
"name": "scipy",
"specs": [
[
"<",
"1.14.0"
]
]
},
{
"name": "utm",
"specs": [
[
">=",
"0.7.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.5.0"
]
]
},
{
"name": "bokeh",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.9.0"
]
]
}
],
"lcname": "arlpy"
}
JSON
