further consolidate text in api.acoustics.rst with module docstrings

MHKiT-Software · Nov 21, 2024 · afc9a28 · afc9a28
1 parent f1de845
commit afc9a28
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/mhkit/acoustics/__init__.py b/mhkit/acoustics/__init__.py
@@ -10,6 +10,9 @@
 are available directly from the main import, while the 
 I/O and graphics submodules are available from 
 ``acoustics.io`` and  ``acoustics.graphics``, respectively.
+The base functions are intended to be used on top of the I/O submodule, and 
+include functionality to calibrate data, create spectral densities, sound 
+pressure levels, and time or band aggregate spectral data.
 """
 
 from mhkit.acoustics import io, graphics