Skip to content

Commit

Permalink
doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
gavinmacaulay committed Oct 3, 2024
1 parent 8d5cab4 commit 5fbae81
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions docs/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,11 @@ The [Tait-Bryan](https://en.wikipedia.org/wiki/Euler_angles) _z_-_y'_-_x''_ (int
Rotations around the _x_-axis are roll (_ɸ_), about the _y_-axis are pitch (_θ_), and about the _z_-axis are yaw (_ψ_). The definitions are such that:

- Pitch (_θ_) values of –90°, 0°, and 90° correspond to acoustic wave incidence angles of tail on, dorsal, and head on, respectively,
- Roll (_ɸ_) values of –90°, 0°, and 90° correspond to acoustic wave incidence angles onto the right, dorsal, and left sides of the organism, respectively, and
- a _ψ_ value of 0° occurs when the organism lies along the positive _x_-axis and positive _ψ_ values rotate the organism's head towards the _y_-axis.

- Roll (_ɸ_) values of –90°, 0°, and 90° correspond to acoustic wave incidence angles onto the right, dorsal, and left sides of the organism, respectively,
- A yaw (_ψ_) value of 0° occurs when the organism lies along the positive _x_-axis and positive yaw values rotate the organism's head towards the positive _y_-axis.

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.


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

![The coordinate system](resources/coordinate_system.svg)



## Code style

Contributions of code should follow standardised or community-agreed styles and be provided in (or added to) a structure suitable for packaging and uploading to package libraries. For Python this includes `pip` and/or `conda`, for R this would be `CRAN`, for Matlab this would be a toolbox on the MATLAB File Exchange, etc.
Expand Down

0 comments on commit 5fbae81

Please sign in to comment.