shipshape 0.2.0__tar.gz → 0.3.0__tar.gz

shipshape-0.3.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: shipshape
+Version: 0.3.0
+Summary: Open-source parametric vessel design and validation library
+Project-URL: Homepage, https://github.com/solar-proa/shipshape
+Project-URL: Repository, https://github.com/solar-proa/shipshape
+Author-email: Solar Proa <solar.proa@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: hydrostatics,naval-architecture,structural-validation,vessel-design
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: numpy
+Provides-Extra: diagrams
+Requires-Dist: matplotlib; extra == 'diagrams'
+Provides-Extra: geometry
+Requires-Dist: numpy; extra == 'geometry'
+Description-Content-Type: text/markdown
+
+# shipshape
+
+Open-source parametric vessel design and validation library.
+
+Shipshape provides boat-design-independent tools for naval engineering analysis. It is used by [Solar Proa CAD](https://github.com/solar-proa/CAD) but can be applied to any parametric vessel design.
+
+## Modules
+
+| Module | Description | Requires FreeCAD |
+|--------|-------------|------------------|
+| `parameter` | Merge base parameters and compute derived values via a project-supplied plugin | No |
+| `mass` | Compute component masses from a FreeCAD design and material properties | Yes |
+| `buoyancy` | Find equilibrium pose (sinkage, pitch, roll) using Newton-Raphson iteration | Yes |
+| `gz` | Compute the GZ righting-arm curve over a range of heel angles | Yes |
+| `physics` | Center-of-gravity and center-of-buoyancy calculations | Yes |
+| `validate_structure` | Structural validation: aka, mast, spine, brace, gunwale, wave slam, capsize analysis | No |
+
+## Installation
+
+```bash
+pip install shipshape
+```
+
+For modules that require FreeCAD geometry (mass, buoyancy, gz, physics), install FreeCAD via conda-forge:
+
+```bash
+conda install -c conda-forge freecad
+```
+
+For diagram generation (validate_structure plots):
+
+```bash
+pip install shipshape[diagrams]
+```
+
+## CLI Usage
+
+Each module can be run as a CLI tool via `python -m shipshape.<module>`.
+
+### parameter
+
+Merges boat and configuration JSON files, then calls a project-supplied `compute_derived()` function to calculate derived values.
+
+```bash
+PYTHONPATH=. python -m shipshape.parameter \
+    --compute myproject.parameter.compute \
+    --boat constants/boats/boat.json \
+    --configuration constants/configurations/config.json \
+    --output artifact/parameters.json
+```
+
+The `--compute` argument is a dotted module path. The module must export a `compute_derived(data: dict) -> dict` function.
+
+### mass
+
+```bash
+python -m shipshape.mass \
+    --design artifact/boat.design.FCStd \
+    --materials constants/material/materials.json \
+    --output artifact/boat.mass.json
+```
+
+### buoyancy
+
+```bash
+python -m shipshape.buoyancy \
+    --design artifact/boat.design.FCStd \
+    --materials constants/material/materials.json \
+    --output artifact/boat.buoyancy.json
+```
+
+### gz
+
+```bash
+python -m shipshape.gz \
+    --design artifact/boat.design.FCStd \
+    --buoyancy artifact/boat.buoyancy.json \
+    --output artifact/boat.gz.json \
+    --output-png artifact/boat.gz.png
+```
+
+### validate_structure
+
+```bash
+python -m shipshape.validate_structure \
+    --parameters artifact/parameters.json \
+    --mass artifact/boat.mass.json \
+    --gz artifact/boat.gz.json \
+    --output artifact/boat.validation.json
+```
+
+## License
+
+MIT

shipshape-0.3.0/README.md

@@ -0,0 +1,94 @@
+# shipshape
+
+Open-source parametric vessel design and validation library.
+
+Shipshape provides boat-design-independent tools for naval engineering analysis. It is used by [Solar Proa CAD](https://github.com/solar-proa/CAD) but can be applied to any parametric vessel design.
+
+## Modules
+
+| Module | Description | Requires FreeCAD |
+|--------|-------------|------------------|
+| `parameter` | Merge base parameters and compute derived values via a project-supplied plugin | No |
+| `mass` | Compute component masses from a FreeCAD design and material properties | Yes |
+| `buoyancy` | Find equilibrium pose (sinkage, pitch, roll) using Newton-Raphson iteration | Yes |
+| `gz` | Compute the GZ righting-arm curve over a range of heel angles | Yes |
+| `physics` | Center-of-gravity and center-of-buoyancy calculations | Yes |
+| `validate_structure` | Structural validation: aka, mast, spine, brace, gunwale, wave slam, capsize analysis | No |
+
+## Installation
+
+```bash
+pip install shipshape
+```
+
+For modules that require FreeCAD geometry (mass, buoyancy, gz, physics), install FreeCAD via conda-forge:
+
+```bash
+conda install -c conda-forge freecad
+```
+
+For diagram generation (validate_structure plots):
+
+```bash
+pip install shipshape[diagrams]
+```
+
+## CLI Usage
+
+Each module can be run as a CLI tool via `python -m shipshape.<module>`.
+
+### parameter
+
+Merges boat and configuration JSON files, then calls a project-supplied `compute_derived()` function to calculate derived values.
+
+```bash
+PYTHONPATH=. python -m shipshape.parameter \
+    --compute myproject.parameter.compute \
+    --boat constants/boats/boat.json \
+    --configuration constants/configurations/config.json \
+    --output artifact/parameters.json
+```
+
+The `--compute` argument is a dotted module path. The module must export a `compute_derived(data: dict) -> dict` function.
+
+### mass
+
+```bash
+python -m shipshape.mass \
+    --design artifact/boat.design.FCStd \
+    --materials constants/material/materials.json \
+    --output artifact/boat.mass.json
+```
+
+### buoyancy
+
+```bash
+python -m shipshape.buoyancy \
+    --design artifact/boat.design.FCStd \
+    --materials constants/material/materials.json \
+    --output artifact/boat.buoyancy.json
+```
+
+### gz
+
+```bash
+python -m shipshape.gz \
+    --design artifact/boat.design.FCStd \
+    --buoyancy artifact/boat.buoyancy.json \
+    --output artifact/boat.gz.json \
+    --output-png artifact/boat.gz.png
+```
+
+### validate_structure
+
+```bash
+python -m shipshape.validate_structure \
+    --parameters artifact/parameters.json \
+    --mass artifact/boat.mass.json \
+    --gz artifact/boat.gz.json \
+    --output artifact/boat.validation.json
+```
+
+## License
+
+MIT

{shipshape-0.2.0 → shipshape-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "shipshape"
-version = "0.2.0"
+version = "0.3.0"
 description = "Open-source parametric vessel design and validation library"
 readme = "README.md"
 license = "MIT"

shipshape-0.3.0/src/shipshape/parameter/__init__.py

@@ -0,0 +1 @@
+"""Parameter computation for parametric vessel designs."""

{shipshape-0.2.0 → shipshape-0.3.0}/src/shipshape/parameter/__main__.py

@@ -1,21 +1,24 @@
 #!/usr/bin/env python3
 """CLI entry point for parameter computation."""
 
+import importlib
 import json
 import os
 import argparse
 
-from .compute import compute_derived
-
 
 def main():
     parser = argparse.ArgumentParser(description='Compute parameters')
+    parser.add_argument('--compute', required=True,
+                        help='Dotted module path providing compute_derived()')
     parser.add_argument('--boat', required=True, help='Path to boat constants')
     parser.add_argument('--configuration', required=True, help='Path to configuration constants')
     parser.add_argument('--output', required=True, help='Path to output JSON artifact')
 
     args = parser.parse_args()
 
+    module = importlib.import_module(args.compute)
+
     with open(args.boat, 'r') as b:
         boat_data = json.load(b)
 
@@ -23,7 +26,7 @@ def main():
         configuration_data = json.load(c)
 
     data = boat_data | configuration_data
-    data = compute_derived(data)
+    data = module.compute_derived(data)
 
     os.makedirs(os.path.dirname(args.output) or '.', exist_ok=True)
     with open(args.output, 'w') as f:

shipshape-0.2.0/PKG-INFO

@@ -1,45 +0,0 @@
-Metadata-Version: 2.4
-Name: shipshape
-Version: 0.2.0
-Summary: Open-source parametric vessel design and validation library
-Project-URL: Homepage, https://github.com/solar-proa/shipshape
-Project-URL: Repository, https://github.com/solar-proa/shipshape
-Author-email: Solar Proa <solar.proa@gmail.com>
-License-Expression: MIT
-License-File: LICENSE
-Keywords: hydrostatics,naval-architecture,structural-validation,vessel-design
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.10
-Requires-Dist: numpy
-Provides-Extra: diagrams
-Requires-Dist: matplotlib; extra == 'diagrams'
-Provides-Extra: geometry
-Requires-Dist: numpy; extra == 'geometry'
-Description-Content-Type: text/markdown
-
-# shipshape
-
-Open-source parametric vessel design and validation library.
-
-## Installation
-
-```
-pip install shipshape
-```
-
-## Usage
-
-```python
-from shipshape.parameter import compute_derived
-from shipshape.validate_structure import run_validation
-
-# Compute derived parameters from base parameters
-params = compute_derived(base_params)
-
-# Run structural validation
-results = run_validation(params, mass_data)
-```

shipshape-0.2.0/README.md

@@ -1,22 +0,0 @@
-# shipshape
-
-Open-source parametric vessel design and validation library.
-
-## Installation
-
-```
-pip install shipshape
-```
-
-## Usage
-
-```python
-from shipshape.parameter import compute_derived
-from shipshape.validate_structure import run_validation
-
-# Compute derived parameters from base parameters
-params = compute_derived(base_params)
-
-# Run structural validation
-results = run_validation(params, mass_data)
-```

shipshape-0.2.0/src/shipshape/parameter/__init__.py

@@ -1,5 +0,0 @@
-"""Parameter computation for parametric vessel designs."""
-
-from .compute import compute_derived
-
-__all__ = ["compute_derived"]

shipshape-0.2.0/src/shipshape/parameter/compute.py

@@ -1,139 +0,0 @@
-"""Compute derived parameters from base parameters."""
-
-from typing import Dict, Any
-
-
-def compute_derived(base: Dict[str, Any]) -> Dict[str, Any]:
-    """
-    Compute all derived parameters from base parameters.
-    Returns a complete parameter dictionary with both base and derived values.
-    """
-    params = base.copy()
-
-    # Constants
-    mm_in_one_inch = 25.4
-
-    # Derived dimensions
-    params['mm_in_one_inch'] = mm_in_one_inch
-    params['stringer_width'] = base['stringer_width_inches'] * mm_in_one_inch
-    params['clamp_width'] = base['clamp_width_inches'] * mm_in_one_inch
-    params['clamp_height'] = base['clamp_height_inches'] * mm_in_one_inch
-    params['vaka_stringer_width'] = base['vaka_stringer_width_inches'] * mm_in_one_inch
-    params['vaka_stringer_height'] = base['vaka_stringer_height_inches'] * mm_in_one_inch
-    params['frame_width'] = base['frame_width_inches'] * mm_in_one_inch
-    params['frame_depth'] = base['frame_depth_inches'] * mm_in_one_inch
-    params['bottom_height'] = base['bottom_height_inches'] * mm_in_one_inch
-
-    # Aka length depends on panels and deck
-    params['aka_length'] = (base['panel_length'] * base['panels_transversal'] +
-                            base['deck_width'])
-
-    # Bottom thickness same as vaka
-    params['bottom_thickness'] = base['vaka_thickness']
-
-    # Crossdeck dimensions
-    params['crossdeck_width'] = base['panel_width'] / base['akas_per_panel']
-    params['crossdeck_thickness'] = base['deck_thickness']
-    params['crossdeck_length'] = (base['panels_transversal'] * base['panel_length'] +
-                                  (base['deck_width'] - base['vaka_width']) / 2 +
-                                  params['stringer_width'])
-
-    # Cockpit length: distance from center to first aka's inner edge, doubled
-    # First aka Y position depends on akas_per_panel:
-    # - Single aka: centered in panel at crossdeck_width/2 + panel_width/2
-    # - Multiple akas: at rim distance from panel edge at crossdeck_width/2 + aka_rim
-    if base.get('akas_per_panel', 1) == 1:
-        first_aka_y = params['crossdeck_width'] / 2 + base['panel_width'] / 2
-    else:
-        first_aka_y = params['crossdeck_width'] / 2 + base['aka_rim']
-    params['cockpit_length'] = 2 * first_aka_y - base['aka_width']
-
-    # Panel stringer calculations
-    params['panel_stringer_offset'] = (base['panel_length'] / 4 -
-                                       params['stringer_width'] / 2)
-    params['panel_stringer_length'] = (params['crossdeck_width'] +
-                                       base['panels_longitudinal'] * base['panel_width'])
-
-    # Vertical levels (build up from bottom)
-    params['clamp_base_level'] = (params['bottom_height'] + base['freeboard'] -
-                                    params['clamp_height'])
-    params['vaka_stringer_base_level'] = params['clamp_base_level'] - params['freeboard'] / 2
-    params['overhead_base_level'] = (params['clamp_base_level'] +
-                                     params['clamp_height'])
-    params['aka_base_level'] = (params['overhead_base_level'] +
-                                base['overhead_thickness'])
-    params['stringer_base_level'] = params['aka_base_level'] + base['aka_height']
-    params['panel_base_level'] = params['stringer_base_level'] + params['stringer_width']
-    params['deck_base_level'] = params['panel_base_level']
-    params['deck_level'] = params['deck_base_level'] + base['deck_thickness']
-
-    # Spine (uses same sizes as aka)
-    params['spine_thickness'] = base['aka_thickness']
-    params['spine_width'] = base['aka_width']
-    params['spine_base_level'] = params['aka_base_level'] - params['spine_width']
-    params['spine_length'] = (base['panel_width'] * base['panels_longitudinal'] +
-                              params['crossdeck_width'] + base['spine_length_extension'])
-
-    # Beam calculation
-    params['beam'] = (params['aka_length'] + base['aka_cap_thickness'] -
-                     params['spine_width'] + base['ama_diameter'] / 2)
-
-    # Pillar (uses same sizes as aka)
-    params['pillar_thickness'] = base['aka_thickness']
-    params['pillar_width'] = base['aka_width']
-    params['pillar_height'] = params['spine_base_level'] - base['ama_thickness']
-
-    # Ama cone length: cone starts at outer edge of outermost pillar
-    # Calculate Y position of the outermost (last) aka
-    last_panel_index = base['panels_longitudinal'] // 2 - 1
-    last_aka_index = base.get('akas_per_panel', 1) - 1
-    if base.get('akas_per_panel', 1) == 1:
-        last_aka_y = (params['crossdeck_width'] / 2
-                      + last_panel_index * base['panel_width']
-                      + base['panel_width'] / 2)
-    else:
-        aka_spacing = ((base['panel_width'] - 2 * base['aka_rim'])
-                       / (base['akas_per_panel'] - 1))
-        last_aka_y = (params['crossdeck_width'] / 2
-                      + last_panel_index * base['panel_width']
-                      + base['aka_rim'] + last_aka_index * aka_spacing)
-
-    # Vaka x offset (distance from ama centerline to vaka centerline)
-    params['vaka_x_offset'] = (- params['pillar_width'] / 2
-                               + base['panel_length'] * base['panels_transversal']
-                               + base['deck_width'] / 2)
-
-    # Mast calculations
-    params['mast_distance_from_center'] = (base['vaka_length'] / 4 +
-                                           base['mast_distance_from_center_offset'])
-    params['mast_base_level'] = params['bottom_height'] + base['sole_thickness']
-    params['mast_partner_length'] = (base['vaka_width'] -
-                                     base['mast_partner_vaka_clearance'])
-    params['mast_partner_width'] = (base['mast_diameter'] +
-                                    base['mast_partner_width_offset'])
-    params['mast_step_outer_diameter'] = (base['mast_diameter'] +
-                                          base['mast_step_diameter_offset'])
-    params['mast_step_inner_diameter'] = base['mast_diameter']
-
-    # Yard spar height
-    params['yard_spar_height'] = (base['mast_height'] -
-                                  base['yard_spar_distance_from_top'])
-
-    # Boom length matches yard length (rectangular sails)
-    params['boom_length'] = base['yard_length']
-    params['sail_area_m2'] = (2 * base['sail_height'] / 1000
-                              * base['sail_width'] / 1000)
-
-    # Rudder calculations
-    params['rudder_bearing_block_height'] = params['stringer_width']
-    params['rudder_vaka_mount_base_level'] = ((params['bottom_height'] +
-                                               base['freeboard']) / 2)
-    params['rudder_rib_length'] = (base['rudder_blade_length'] -
-                                   base['rudder_rib_clearance'])
-
-    # Tiller dimensions (uses stringer sizes)
-    params['tiller_width'] = params['stringer_width']
-    params['tiller_thickness'] = base['stringer_thickness']
-    params['tiller_length'] = 490  # This was hardcoded in original
-
-    return params