Skip to content

Commit

Permalink
Add ESModel to docs + tweak docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
gavinmacaulay committed Aug 21, 2024
1 parent 1cb9c09 commit 905b6ad
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
3 changes: 3 additions & 0 deletions docs/api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Each type of model is contained in a separate Python class (with name ending in
## DCMModel
::: echosms.DCMModel

## ESModel
::: echosms.ESModel

## ReferenceModels
Reference models are the models and parameters defined in the Jech et al, 2015 paper. The parameters are stored in a TOML-formatted file in the echoSMs repository and the ``ReferenceModels`` class provides easy access to the data in that file.

Expand Down
7 changes: 3 additions & 4 deletions src/echosms/esmodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
class ESModel(ScatterModelBase):
"""Elastic sphere (ES) scattering model.
This class calculates acoustic scatter from spheres and shells with various
boundary conditions, as listed in the ``boundary_types`` class attribute.
This class calculates acoustic scatter from elastic spheres.
"""

def __init__(self):
Expand All @@ -34,9 +33,9 @@ def calculate_ts_single(self, medium_c, medium_rho, diameter, theta, f, boundary
Parameters
----------
medium_c : float
Sound speed in the fluid medium surrounding the target [m/s].
Sound speed in the fluid medium surrounding the sphere [m/s].
medium_rho : float
Density of the fluid medium surrounding the target [kg/m³].
Density of the fluid medium surrounding the sphere [kg/m³].
diameter : float
Diameter of the sphere [m].
theta : float
Expand Down

0 comments on commit 905b6ad

Please sign in to comment.