Skip to content

Commit cc8c9fa

Browse files
committed
docs(uwapm,bf): minor documentation updates (fixes #28 and #34)
1 parent d085958 commit cc8c9fa

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

arlpy/bf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ def broadband(x, fs, nfft, sd, f0=0, fmin=None, fmax=None, overlap=0, beamformer
356356
:param fs: sampling rate for array data (Hz)
357357
:param c: wave propagation speed (m/s)
358358
:param nfft: STFT window size
359-
:param sd: steering distances (m)
359+
:param sd: steering delays (s)
360360
:param f0: carrier frequency (for baseband data) (Hz)
361361
:param fmin: minimum frequency to integrate (Hz)
362362
:param fmax: maximum frequency to integrate (Hz)

arlpy/uwapm.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"""Underwater acoustic propagation modeling toolbox.
1212
1313
This toolbox currently uses the Bellhop acoustic propagation model. For this model
14-
to work, the `acoustic toolbox <http://oalib.hlsresearch.com/AcousticsToolbox/>`_
14+
to work, the `acoustic toolbox <https://oalib-acoustics.org/>`_
1515
must be installed on your computer and `bellhop.exe` should be in your PATH.
1616
1717
.. sidebar:: Sample Jupyter notebook
@@ -69,7 +69,7 @@ def create_env2d(**kv):
6969
profile be provided as a Nx2 array of (depth, sound speed):
7070
7171
>>> import arlpy.uwapm as pm
72-
>>> env = pm.create_env2d(depth=20, soundspeed=[[0,1540], [5,1535], [20,1530]])
72+
>>> env = pm.create_env2d(depth=20, soundspeed=[[0,1540], [5,1535], [10,1535], [20,1530]])
7373
7474
The default environment has a constant water depth. A range dependent bathymetry
7575
can be provided as a Nx2 array of (range, water depth):

docs/_static/bellhop.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -11775,7 +11775,7 @@
1177511775
</div>
1177611776
<div class="inner_cell">
1177711777
<div class="text_cell_render border-box-sizing rendered_html">
11778-
<h1 id="Underwater-acoustic-propagation-modeling-with-arlpy-and-Bellhop">Underwater acoustic propagation modeling with arlpy and Bellhop<a class="anchor-link" href="#Underwater-acoustic-propagation-modeling-with-arlpy-and-Bellhop">&#182;</a></h1><p>The underwater acoustic propagation modeling toolbox (<code>uwapm</code>) in <code>arlpy</code> is integrated with the popular <a href="http://oalib.hlsresearch.com/Rays/index.html">Bellhop ray tracer</a> distributed as part of the <a href="http://oalib.hlsresearch.com/AcousticsToolbox/">acoustics toolbox</a>. In this notebook, we see how to use <code>arlpy.uwapm</code> to simplify the use of Bellhop for modeling.</p>
11778+
<h1 id="Underwater-acoustic-propagation-modeling-with-arlpy-and-Bellhop">Underwater acoustic propagation modeling with arlpy and Bellhop<a class="anchor-link" href="#Underwater-acoustic-propagation-modeling-with-arlpy-and-Bellhop">&#182;</a></h1><p>The underwater acoustic propagation modeling toolbox (<code>uwapm</code>) in <code>arlpy</code> is integrated with the popular Bellhop ray tracer distributed as part of the <a href="https://oalib-acoustics.org/">acoustics toolbox</a>. In this notebook, we see how to use <code>arlpy.uwapm</code> to simplify the use of Bellhop for modeling.</p>
1177911779

1178011780
</div>
1178111781
</div>
@@ -11786,7 +11786,7 @@ <h1 id="Underwater-acoustic-propagation-modeling-with-arlpy-and-Bellhop">Underwa
1178611786
<div class="text_cell_render border-box-sizing rendered_html">
1178711787
<h2 id="Prerequisites">Prerequisites<a class="anchor-link" href="#Prerequisites">&#182;</a></h2><ul>
1178811788
<li>Install <a href="https://pypi.org/project/arlpy/">arlpy</a> (v1.5 or higher)</li>
11789-
<li>Install the <a href="http://oalib.hlsresearch.com/Modes/AcousticsToolbox/">acoustics toolbox</a> (6 July 2018 version or later)</li>
11789+
<li>Install the <a href="https://oalib-acoustics.org/">acoustics toolbox</a> (6 July 2018 version or later)</li>
1179011790
</ul>
1179111791

1179211792
</div>

samples/bellhop.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# Underwater acoustic propagation modeling with arlpy and Bellhop\n",
88
"\n",
9-
"The underwater acoustic propagation modeling toolbox (`uwapm`) in `arlpy` is integrated with the popular [Bellhop ray tracer](http://oalib.hlsresearch.com/Rays/index.html) distributed as part of the [acoustics toolbox](http://oalib.hlsresearch.com/Modes/AcousticsToolbox/). In this notebook, we see how to use `arlpy.uwapm` to simplify the use of Bellhop for modeling."
9+
"The underwater acoustic propagation modeling toolbox (`uwapm`) in `arlpy` is integrated with the popular Bellhop ray tracer distributed as part of the [acoustics toolbox](https://oalib-acoustics.org/). In this notebook, we see how to use `arlpy.uwapm` to simplify the use of Bellhop for modeling."
1010
]
1111
},
1212
{
@@ -16,7 +16,7 @@
1616
"## Prerequisites\n",
1717
"\n",
1818
"- Install [arlpy](https://pypi.org/project/arlpy/) (v1.5 or higher)\n",
19-
"- Install the [acoustics toolbox](http://oalib.hlsresearch.com/Modes/AcousticsToolbox/) (6 July 2018 version or later)"
19+
"- Install the [acoustics toolbox](https://oalib-acoustics.org/) (6 July 2018 version or later)"
2020
]
2121
},
2222
{

0 commit comments

Comments
 (0)