Get started#
This guide covers installation, getting started, and important information for using NavalToolbox.
Install NavalToolbox from PyPI or build from source.
Get started quickly with basic examples.
Features#
⚓ Hull Geometry: Load and manipulate ship hulls from STL/VTK files
🚢 Multi-hull Support: Catamarans, trimarans, and arbitrary configurations
📊 Hydrostatics: Volume, COB, Waterplane (\(A_{wp}\), LCF, \(BM_t\), \(BM_l\)), Free Surface Correction (\(GM_{dry}/GM_{wet}`\))
⚖️ Stability Analysis: GZ curve calculation with automatic trim optimization
🌊 Downflooding Detection: Automatic detection of submerged openings
🛢️ Tank Management: Fill levels, free surface effects, sounding tables
💨 Wind Heeling: Silhouette-based wind calculations (DXF/VTK support)
⚡ High Performance: Rust backend with Python convenience
License#
This project is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later): NavalToolbox/navaltoolbox-lib
Disclaimer#
Warning
NavalToolbox has been developed with care to ensure that all models and methods are correct, and that calculations reflect the most accurate results achievable with the implemented algorithms.
However, results must not be considered as a guarantee of performance.
The author cannot be held responsible for any inaccuracies in the calculations or for any consequences arising from the use of this software. Users are advised to independently verify critical calculations and to use this software as a tool to support, not replace, professional engineering judgment.