Welcome to shoeboxpy’s documentation!
shoeboxpy provides lightweight 3-DOF and 6-DOF rigid-body vessel models (“shoebox” approximation) with added mass, Coriolis, linear damping and simple hydrostatic restoring. It is intended for quick prototyping, teaching and algorithm development where a full CFD model would be overkill.
Note
The models use small-angle roll/pitch restoring and diagonal added mass/damping approximations. They are NOT a substitute for high-fidelity design / certification analyses.
Getting started
If this is your first time, read Getting Started for installation, a minimal example and common tasks. For the underlying equations, see Theory.
API overview
The two core classes are shoeboxpy.model3dof.Shoebox and shoeboxpy.model6dof.Shoebox.