Installation

WaveVortexModel requires MATLAB R2025b or newer. MPM installs the declared OceanKit dependencies automatically.

Install from OceanKit

Clone or download the OceanKit repository, then register its local folder with MPM:

mpmAddRepository("OceanKit","local/path/to/OceanKit")

Install WaveVortexModel and its dependencies:

mpminstall("WaveVortexModel")

The installed package can be inspected with:

mpmlist("WaveVortexModel")

See OceanKit installation for repository management, updates, and removal.

Install an authoring checkout

Ordinary users should install the released OceanKit package. Clone the authoring repository only when developing WaveVortexModel or rebuilding its documentation:

git clone https://github.com/JeffreyEarly/wave-vortex-model.git

Install that checkout with authoring files enabled:

mpminstall("local/path/to/wave-vortex-model",Authoring=true)

Runtime dependencies still come from the registered OceanKit repository. Documentation generation additionally requires the authoring-only package ClassDocumentation@1.3.2; it is not a WaveVortexModel runtime dependency.