Installation

Requirements

MATLAB Package Manager is available in MATLAB R2024b and newer. Package requirements can be more specific: the current WaveVortexModel release requires R2025b or newer, and FFTWTransforms currently provides a validated backend for R2026a on Apple silicon. Check the package’s source documentation in the package catalog for platform details.

Register the repository

Clone the OceanKit repository and register it with MATLAB Package Manager.

git clone https://github.com/JeffreyEarly/OceanKit.git

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

Once the repository is registered, search or install packages from it:

mpmsearch(Repository="OceanKit")
mpminstall("WaveVortexModel")

Common MPM Commands

Use these commands when working with the OceanKit repository:

mpmsearch(Repository="OceanKit")
mpmlist
mpmuninstall("WaveVortexModel")

To uninstall every installed package:

pkgs = mpmlist;
mpmuninstall([pkgs.Name])

Authoring Workflow

OceanKit is the distribution repository. If you intend to edit and commit changes to a package, clone the package’s own Git repository directly and install that package in authoring mode:

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

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

That keeps your working copy in the real authoring repository while still allowing MPM to resolve dependencies through OceanKit.