docs(uwapm,bf): minor documentation updates (fixes #28 and #34)

arlpy/bf.py

@@ -356,7 +356,7 @@ def broadband(x, fs, nfft, sd, f0=0, fmin=None, fmax=None, overlap=0, beamformer
     :param fs: sampling rate for array data (Hz)
     :param c: wave propagation speed (m/s)
     :param nfft: STFT window size
-    :param sd: steering distances (m)
+    :param sd: steering delays (s)
     :param f0: carrier frequency (for baseband data) (Hz)
     :param fmin: minimum frequency to integrate (Hz)
     :param fmax: maximum frequency to integrate (Hz)

arlpy/uwapm.py

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

docs/_static/bellhop.html

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

samples/bellhop.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# Underwater acoustic propagation modeling with arlpy and Bellhop\n",
     "\n",
-    "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."
+    "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."
    ]
   },
   {
@@ -16,7 +16,7 @@
     "## Prerequisites\n",
     "\n",
     "- Install [arlpy](https://pypi.org/project/arlpy/) (v1.5 or higher)\n",
-    "- Install the [acoustics toolbox](http://oalib.hlsresearch.com/Modes/AcousticsToolbox/) (6 July 2018 version or later)"
+    "- Install the [acoustics toolbox](https://oalib-acoustics.org/) (6 July 2018 version or later)"
    ]
   },
   {