User guide

The user guide introduces the main WaveVortexModel workflows and connects them to the complete API reference.

• Start with the Introduction to understand WVTransform and WVModel.
• Use Using WVTransform to choose a transform, initialize a state, and evaluate physical fields.
• Consult Capabilities and limitations when choosing interpolation, integration, forcing, output, or extension features.
• Compare the two source-built workflows in Compiled execution, then use the compiled MATLAB backend preview or standalone portable runtime only when its narrower contract fits the model.
• Read Adding forcing before integrating nonlinear dynamics.
• Use Reading and writing files for transform persistence, model output, and restart.

---

Table of contents

• Introduction
• Using WVTransform
• Capabilities and limitations
• Adding forcing
• Reading and writing files
• Reading and writing files: advanced topics
• Creating new state variables
• Wavenumbers, modes, and indices
• NetCDF conventions