navaltoolbox 0.4.2

High-performance naval architecture library for hydrostatics, stability, and tank calculations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

// Copyright (C) 2026 Antoine ANCEAU
//
// This file is part of navaltoolbox.
//
// navaltoolbox is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! # NavalToolbox
//!
//! High-performance naval architecture library for hydrostatics, stability, and tank calculations.
//!
//! ## Features
//! - Hull geometry loading (STL, VTK)
//! - Multi-hull vessel support
//! - Hydrostatic calculations (volume, CoB, waterplane properties, metacentric heights)
//! - Stability analysis (KN curves, GZ curves)
//! - Tank management with free surface effects
//!
//! ## Usage
//! ```rust,ignore
//! use navaltoolbox::{Hull, Vessel, HydrostaticsCalculator};
//!
//! let hull = Hull::from_stl("ship.stl")?;
//! let vessel = Vessel::new(hull);
//! let calc = HydrostaticsCalculator::new(&vessel, 1025.0);
//! let state = calc.from_draft(5.0, 0.0, 0.0)?;
//! println!("Volume: {} m³", state.volume);
//! ```
//!
//! ## Disclaimer
//!
//! NavalToolbox has been developed with care to ensure that all models and methods are correct.
//! 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.

pub mod appendage;
pub mod deckedge;
pub mod downflooding;
pub mod hull;
pub mod hydrostatics;
pub mod mesh;
pub mod scripting;
pub mod silhouette;
pub mod stability;
pub mod tanks;
pub mod vessel;

// Re-export main types
pub use appendage::{Appendage, AppendageGeometry, AppendageLoadError};
pub use deckedge::{DeckEdge, DeckEdgeLoadError, DeckEdgeSide};
pub use downflooding::{DownfloodingOpening, OpeningGeometry, OpeningType};
pub use hull::Hull;
pub use hydrostatics::{HydrostaticState, HydrostaticsCalculator};
pub use scripting::{
    CriteriaContext, CriteriaResult, CriteriaStatus, CriterionResult, PlotData, PlotElement,
    ScriptEngine, ScriptError,
};
pub use silhouette::Silhouette;
pub use stability::{
    CompleteStabilityResult, StabilityCalculator, StabilityCurve, StabilityPoint, WindHeelingData,
};
pub use tanks::{Tank, TankState};
pub use vessel::Vessel;

// ============================================================================
// Python Bindings
// ============================================================================

#[cfg(feature = "python")]
mod python;

#[cfg(feature = "python")]
pub use python::*;