ARL Python Tools
================
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 <http://arlpy.readthedocs.io>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/org-arl/arlpy",
"name": "arlpy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "underwater acoustics signal processing communication",
"author": "Mandar Chitre",
"author_email": "mandar@nus.edu.sg",
"download_url": "https://files.pythonhosted.org/packages/ba/b8/cd2856796a7fd5c83c8c9ae73a0a49105e31251b0da7ba693ac85aacc197/arlpy-1.8.4.tar.gz",
"platform": null,
"description": "ARL Python Tools\n================\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\nGeneral modules\n---------------\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\nSpecial-purpose modules\n-----------------------\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\nUsage\n-----\n\nInstallation::\n\n pip install arlpy\n\nTo import all general modules::\n\n import arlpy\n\nNotes\n-----\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\nUseful links\n------------\n\n * `arlpy home <https://github.com/org-arl/arlpy>`_\n * `arlpy documentation <http://arlpy.readthedocs.io>`_\n\n\n",
"bugtrack_url": null,
"license": "BSD (3-clause)",
"summary": "ARL Python Tools",
"version": "1.8.4",
"project_urls": {
"Homepage": "https://github.com/org-arl/arlpy"
},
"split_keywords": [
"underwater",
"acoustics",
"signal",
"processing",
"communication"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bab8cd2856796a7fd5c83c8c9ae73a0a49105e31251b0da7ba693ac85aacc197",
"md5": "d89bdc777dc77d6b1022a75d87d83ab3",
"sha256": "87dc3d450cf545f2cecbc8b73c2475f872fcf4b38c267f56e1d51b96005367e9"
},
"downloads": -1,
"filename": "arlpy-1.8.4.tar.gz",
"has_sig": false,
"md5_digest": "d89bdc777dc77d6b1022a75d87d83ab3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44173,
"upload_time": "2023-10-31T01:03:27",
"upload_time_iso_8601": "2023-10-31T01:03:27.209473Z",
"url": "https://files.pythonhosted.org/packages/ba/b8/cd2856796a7fd5c83c8c9ae73a0a49105e31251b0da7ba693ac85aacc197/arlpy-1.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-31 01:03:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "org-arl",
"github_project": "arlpy",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "arlpy"
}
JSON
