Skip to content

Commit

Permalink
Polish documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gavinmacaulay committed Sep 11, 2024
1 parent 147784e commit ab03352
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ An objective of echoSMs is to provide scattering models in a form that is easy t

## Units

We use SI units for the model parameters and do not use SI prefixes for model inputs and outputs. The two exceptions to this are the use of degrees rather than radians for angles and the use of deciBels for target strength.
We use SI units for the model parameters for model inputs and outputs, except for angles (degrees instead of radians) and target strength (use use deciBels).

| Parameter | Units | Notes |
|-----------|-------|--|
Expand All @@ -21,7 +21,7 @@ We use SI units for the model parameters and do not use SI prefixes for model in

A single coordinate system should be used for all models provided by echoSMs. The aim is to ease the comparison of results between different models.

The right-handed spherical coordinate system as defined by ISO 80000-2[^1] is to be used, where organisms are oriented such that θ corresponds to pitch and ɸ to roll, as illustrated below, where the organism lies along the z-axis and the positive x-axis extends above the organism:
The right-handed spherical coordinate system as defined by ISO 80000-2[^1] is to be used, where organisms are oriented such that θ corresponds to pitch and ɸ to roll, as illustrated below, where the organism lies along the _z_-axis and the positive _x_-axis extends above the organism:

<!--- This code will include an html file, originally used to
include a live 3D view of the coordinate system, but there are
Expand All @@ -33,7 +33,7 @@ issues with the html so for the moment a 2D image is used.

![The coordinate system](resources/coordinate_system.svg){:style="height:400px;width400px"}

The definitions are such that θ values of 0°, 90°, and 180° correspond to organism pitches of head on, dorsal, and tail on, respectively, and positive values of ɸ indicate a roll to starboard. All model code should accept angles and produce results in this coordinate system. If the model calculations use a different coordinate system, the code should internally convert between the system given above and the version used in the code.
The definitions are such that _θ_ values of 0°, 90°, and 180° correspond to organism pitches of head on, dorsal, and tail on, respectively, and positive values of _ɸ_ indicate a roll to starboard. All model code should accept angles and produce results in this coordinate system. If the model calculations use a different coordinate system, the code should internally convert between the system given above and the version used in the code.

## Code style

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The initial set of acoustic scattering models will be those used in [Jech et al.
1. Exact solutions and canonical shapes ([see table below][exact-solutions]),
2. Approximate analytical models applied to canonical shapes ([see table below][approximate-analytical-models-and-shapes]),
3. Approximate analytical models applied to complex shapes approximating biological targets, such as fish and zooplankton,
4. Mumerical models applied to canonical shapes and biological targets (this phase will depend on time and funding).
4. Numerical models applied to canonical shapes and biological targets (this phase will depend on time and funding).

### Exact Solutions

Expand Down

0 comments on commit ab03352

Please sign in to comment.