navaltoolbox 0.2.0__tar.gz → 0.3.0__tar.gz

{navaltoolbox-0.2.0 → navaltoolbox-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: navaltoolbox
-Version: 0.2.0
+Version: 0.3.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
@@ -12,6 +12,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Rust
 Classifier: Topic :: Scientific/Engineering
+Requires-Dist: plotly>=5.0.0
+Requires-Dist: numpy>=1.20.0
 Summary: High-performance naval architecture library for hydrostatics, stability, and tank calculations
 Keywords: naval-architecture,hydrostatics,stability,marine-engineering,ship-design
 Home-Page: https://github.com/NavalToolbox/navaltoolbox-lib
@@ -45,6 +47,9 @@ NavalToolbox provides fast and accurate naval architecture calculations through
 - 🌊 **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)
+- 📝 **Scriptable Verification**: Rhai scripting engine for custom stability criteria
+- 🧊 **3D Visualization**: Interactive vessel and hydrostatic visualization with Plotly
+- 📈 **Plotting**: Built-in 2D plotting utilities with Matplotlib integration
 - ⚡ **High Performance**: Rust backend with Python convenience
 
 ## Installation
@@ -89,7 +94,7 @@ vessel = Vessel(hull)
 calc = HydrostaticsCalculator(vessel, water_density=1025.0)
 
 # Option 1: At draft with VCG (computes stability)
-state = calc.calculate_at_draft(draft=5.0, vcg=7.0)
+state = calc.from_draft(draft=5.0, vcg=7.0)
 
 print(f"Volume: {state.volume:.1f} m³")
 print(f"Displacement: {state.displacement:.0f} kg")
@@ -100,7 +105,7 @@ print(f"GMT (wet): {state.gmt:.3f} m")
 print(f"GMT (dry): {state.gmt_dry:.3f} m")
 
 # Option 2: Find draft for displacement
-state_disp = calc.calculate_at_displacement(512500.0)
+state_disp = calc.from_displacement(512500.0)
 print(f"Draft for {state_disp.displacement:.0f}kg: {state_disp.draft:.3f} m")
 ```
 
@@ -119,7 +124,7 @@ displacement_mass = 8635000.0  # kg
 cog = (71.67, 0.0, 7.555)      # LCG, TCG, VCG in meters
 heels = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90]
 
-curve = calc.calculate_gz_curve(displacement_mass, cog, heels)
+curve = calc.gz_curve(displacement_mass, cog, heels)
 
 # Display results
 print("Heel (°)  |  GZ (m)")
@@ -135,90 +140,10 @@ max_heel = heels[max_idx]
 print(f"\nMax GZ: {max_gz:.3f}m at {max_heel}°")
 ```
 
-### Tank Management
-
-```python
-from navaltoolbox import Tank, Vessel, Hull
-
-# Create a vessel
-hull = Hull("ship.stl")
-vessel = Vessel(hull)
-
-# Add a box-shaped tank
-tank = Tank.from_box(
-    name="Fuel Tank 1",
-    x_min=40.0, x_max=50.0,
-    y_min=-5.0, y_max=5.0,
-    z_min=0.0, z_max=3.0,
-    fluid_density=850.0  # diesel fuel
-)
-
-vessel.add_tank(tank)
-
-# Set fill level
-tank.fill_percent = 75.0
-
-# Get tank properties
-print(f"Tank: {tank.name}")
-print(f"Total volume: {tank.total_volume:.1f} m³")
-print(f"Fill volume: {tank.fill_volume:.1f} m³")
-print(f"Fluid mass: {tank.fluid_mass:.0f} kg")
-print(f"Center of gravity: {tank.center_of_gravity}")
-print(f"Free surface moment (transverse): {tank.free_surface_moment_t:.2f} m⁴")
-```
-
-### Multi-hull Vessels
-
-```python
-from navaltoolbox import Hull, Vessel
-
-# Load individual hulls
-port_hull = Hull("port_hull.stl")
-starboard_hull = Hull("starboard_hull.stl")
-
-# Create catamaran
-catamaran = Vessel(port_hull)
-catamaran.add_hull(starboard_hull, offset=(0.0, 8.0, 0.0))  # 8m beam between hulls
-
-# Calculate hydrostatics
-calc = HydrostaticsCalculator(catamaran, water_density=1025.0)
-state = calc.calculate_at_draft(1.5)
-
-print(f"Catamaran displacement: {state.displacement:.0f} kg")
-print(f"Waterplane area: {state.waterplane_area:.1f} m²")
-```
-
-### Downflooding Detection
-
-```python
-from navaltoolbox import Hull, Vessel, DownfloodingOpening, StabilityCalculator
-
-# Create vessel
-hull = Hull("ship.stl")
-vessel = Vessel(hull)
-
-# Add downflooding opening (e.g., air pipe, ventilator)
-opening = DownfloodingOpening.from_point(
-    name="Vent pipe",
-    x=75.0, y=9.8, z=12.5,
-    opening_type="vent"
-)
-vessel.add_downflooding_opening(opening)
-
-# Calculate GZ curve with downflooding detection
-calc = StabilityCalculator(vessel, water_density=1025.0)
-heels = list(range(0, 95, 5))
-curve = calc.calculate_gz_curve(8635000.0, (71.67, 0.0, 7.555), heels)
-
-# Check for downflooding
-for point in curve.points():
-    if point.is_flooding:
-        print(f"⚠️  Downflooding at {point.heel}° - {', '.join(point.flooded_openings)}")
-```
-
 ## Documentation
 
 For more detailed documentation, examples, and API reference, visit:
+- **Documentation**: [GitHub Pages](https://navaltoolbox.github.io/navaltoolbox-lib/)
 - **GitHub Repository**: [NavalToolbox/navaltoolbox-lib](https://github.com/NavalToolbox/navaltoolbox-lib)
 - **Issue Tracker**: [GitHub Issues](https://github.com/NavalToolbox/navaltoolbox-lib/issues)
 

{navaltoolbox-0.2.0 → navaltoolbox-0.3.0}/README.md

@@ -19,6 +19,9 @@ NavalToolbox provides fast and accurate naval architecture calculations through
 - 🌊 **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)
+- 📝 **Scriptable Verification**: Rhai scripting engine for custom stability criteria
+- 🧊 **3D Visualization**: Interactive vessel and hydrostatic visualization with Plotly
+- 📈 **Plotting**: Built-in 2D plotting utilities with Matplotlib integration
 - ⚡ **High Performance**: Rust backend with Python convenience
 
 ## Installation
@@ -63,7 +66,7 @@ vessel = Vessel(hull)
 calc = HydrostaticsCalculator(vessel, water_density=1025.0)
 
 # Option 1: At draft with VCG (computes stability)
-state = calc.calculate_at_draft(draft=5.0, vcg=7.0)
+state = calc.from_draft(draft=5.0, vcg=7.0)
 
 print(f"Volume: {state.volume:.1f} m³")
 print(f"Displacement: {state.displacement:.0f} kg")
@@ -74,7 +77,7 @@ print(f"GMT (wet): {state.gmt:.3f} m")
 print(f"GMT (dry): {state.gmt_dry:.3f} m")
 
 # Option 2: Find draft for displacement
-state_disp = calc.calculate_at_displacement(512500.0)
+state_disp = calc.from_displacement(512500.0)
 print(f"Draft for {state_disp.displacement:.0f}kg: {state_disp.draft:.3f} m")
 ```
 
@@ -93,7 +96,7 @@ displacement_mass = 8635000.0  # kg
 cog = (71.67, 0.0, 7.555)      # LCG, TCG, VCG in meters
 heels = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90]
 
-curve = calc.calculate_gz_curve(displacement_mass, cog, heels)
+curve = calc.gz_curve(displacement_mass, cog, heels)
 
 # Display results
 print("Heel (°)  |  GZ (m)")
@@ -109,90 +112,10 @@ max_heel = heels[max_idx]
 print(f"\nMax GZ: {max_gz:.3f}m at {max_heel}°")
 ```
 
-### Tank Management
-
-```python
-from navaltoolbox import Tank, Vessel, Hull
-
-# Create a vessel
-hull = Hull("ship.stl")
-vessel = Vessel(hull)
-
-# Add a box-shaped tank
-tank = Tank.from_box(
-    name="Fuel Tank 1",
-    x_min=40.0, x_max=50.0,
-    y_min=-5.0, y_max=5.0,
-    z_min=0.0, z_max=3.0,
-    fluid_density=850.0  # diesel fuel
-)
-
-vessel.add_tank(tank)
-
-# Set fill level
-tank.fill_percent = 75.0
-
-# Get tank properties
-print(f"Tank: {tank.name}")
-print(f"Total volume: {tank.total_volume:.1f} m³")
-print(f"Fill volume: {tank.fill_volume:.1f} m³")
-print(f"Fluid mass: {tank.fluid_mass:.0f} kg")
-print(f"Center of gravity: {tank.center_of_gravity}")
-print(f"Free surface moment (transverse): {tank.free_surface_moment_t:.2f} m⁴")
-```
-
-### Multi-hull Vessels
-
-```python
-from navaltoolbox import Hull, Vessel
-
-# Load individual hulls
-port_hull = Hull("port_hull.stl")
-starboard_hull = Hull("starboard_hull.stl")
-
-# Create catamaran
-catamaran = Vessel(port_hull)
-catamaran.add_hull(starboard_hull, offset=(0.0, 8.0, 0.0))  # 8m beam between hulls
-
-# Calculate hydrostatics
-calc = HydrostaticsCalculator(catamaran, water_density=1025.0)
-state = calc.calculate_at_draft(1.5)
-
-print(f"Catamaran displacement: {state.displacement:.0f} kg")
-print(f"Waterplane area: {state.waterplane_area:.1f} m²")
-```
-
-### Downflooding Detection
-
-```python
-from navaltoolbox import Hull, Vessel, DownfloodingOpening, StabilityCalculator
-
-# Create vessel
-hull = Hull("ship.stl")
-vessel = Vessel(hull)
-
-# Add downflooding opening (e.g., air pipe, ventilator)
-opening = DownfloodingOpening.from_point(
-    name="Vent pipe",
-    x=75.0, y=9.8, z=12.5,
-    opening_type="vent"
-)
-vessel.add_downflooding_opening(opening)
-
-# Calculate GZ curve with downflooding detection
-calc = StabilityCalculator(vessel, water_density=1025.0)
-heels = list(range(0, 95, 5))
-curve = calc.calculate_gz_curve(8635000.0, (71.67, 0.0, 7.555), heels)
-
-# Check for downflooding
-for point in curve.points():
-    if point.is_flooding:
-        print(f"⚠️  Downflooding at {point.heel}° - {', '.join(point.flooded_openings)}")
-```
-
 ## Documentation
 
 For more detailed documentation, examples, and API reference, visit:
+- **Documentation**: [GitHub Pages](https://navaltoolbox.github.io/navaltoolbox-lib/)
 - **GitHub Repository**: [NavalToolbox/navaltoolbox-lib](https://github.com/NavalToolbox/navaltoolbox-lib)
 - **Issue Tracker**: [GitHub Issues](https://github.com/NavalToolbox/navaltoolbox-lib/issues)
 

{navaltoolbox-0.2.0 → navaltoolbox-0.3.0}/navaltoolbox/__init__.py

@@ -36,7 +36,7 @@ Example:
     >>> hull = Hull("ship.stl")
     >>> vessel = Vessel(hull)
     >>> calc = HydrostaticsCalculator(vessel)
-    >>> state = calc.calculate_at_draft(5.0)
+    >>> state = calc.from_draft(5.0)
     >>> print(f"Displacement: {state.displacement:.0f} kg")
 """
 
@@ -53,6 +53,11 @@ from .navaltoolbox import (
     StabilityCurve,
     StabilityCalculator,
     Tank,
+    CompleteStabilityResult,
+    CriterionResult,
+    CriteriaResult,
+    CriteriaContext,
+    ScriptEngine,
 )
 
 __all__ = [
@@ -67,4 +72,9 @@ __all__ = [
     "StabilityCurve",
     "StabilityCalculator",
     "Tank",
+    "CompleteStabilityResult",
+    "CriterionResult",
+    "CriteriaResult",
+    "CriteriaContext",
+    "ScriptEngine",
 ]