Added sound speed profile visualisation

kapple19 · Aug 21, 2024 · f12f23f · f12f23f
1 parent f361717
commit f12f23f
Show file tree

Hide file tree

Showing 22 changed files with 318 additions and 575 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
-/docs/build/
+/docs/build/
+/docs/Manifest.toml
+/test/Manifest.toml
diff --git a/Manifest.toml b/Manifest.toml
@@ -2,7 +2,7 @@
 
 julia_version = "1.11.0-rc2"
 manifest_format = "2.0"
-project_hash = "d0c62af25f1e334dc974e47fa84a9579455bd7a6"
+project_hash = "79440dfbc25e977d413e6cab950bb824887b4e5d"
 
 [[deps.Base64]]
 uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

diff --git a/Project.toml b/Project.toml
@@ -6,6 +6,13 @@ version = "1.0.0-DEV"
 [deps]
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 
+[weakdeps]
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+
+[extensions]
+OceanSonarMakieExt = "Makie"
+
 [compat]
 InteractiveUtils = "1.11.0"
+Makie = "0.21.7"
 julia = "1.10"
diff --git a/docs/Manifest.toml b/docs/Manifest.toml
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,4 @@
 [deps]
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 OceanSonar = "03019ade-4524-4ecd-af79-46d4f04a1b56"
diff --git a/docs/src/01_oceanography/01_ocean/01_sound_speed.md b/docs/src/01_oceanography/01_ocean/01_sound_speed.md
diff --git a/docs/src/01_oceanography/01_ocean/01_sound_speed_profiles.md b/docs/src/01_oceanography/01_ocean/01_sound_speed_profiles.md
@@ -0,0 +1,16 @@
+# Ocean Sound Speed Profiles
+
+```@docs
+sound_speed_profile
+```
+
+## Munk Sound Speed Profile
+
+```@docs
+sound_speed_profile(::Model{:Munk}, z::Real; ϵ::Real = 7.37e-3)
+```
+
+```@example
+using OceanSonar, CairoMakie
+visual("Sound Speed 2D", 0, 5e3, Fix1(sound_speed_profile, "Munk"))
+```
diff --git a/docs/src/99_postamble/01_implementation.md b/docs/src/99_postamble/01_implementation.md
@@ -72,3 +72,32 @@ with `listarguments`:
 ```@docs
 listarguments
 ```
+
+## Visualisation
+
+The `visual` and `visual!` functions have methods described throughout the documentation,
+flexibly catering to the variety of types of plots that ocean sonar modelling
+benefits from.
+
+Internally `visual` and `visual!` dispatch on the first argument's `Model` specification
+to specific `Makie` plotting recipes defined by the extension package `OceanSonarMakieExt`.
+Due to the nature of extensions,
+such plotting recipe functions are defined with no arguments in `OceanSonar`
+then `imported` for overloading in the extension package.
+
+```@docs
+visual
+visual!
+```
+
+```@example
+using OceanSonar, CairoMakie
+listmodels(visual)
+```
+
+Supporting the creation of ocean metric visualisations
+is the `OceanAxis2D` function:
+
+```@docs
+OceanAxis2D
+```