Repository navigation
Releases
SEA-Stack v1.1.0
SEA-Stack v1.1.0
SEA-Stack is an open-source C++ platform for offshore and marine energy simulation: YAML-driven cases, linear potential-flow hydrodynamics, multibody dynamics via Project Chrono, optional MoorDyn mooring, PTO and control models, HDF5 results, and a real-time 3D viewer.
v1.1.0 (November 2026) is the release after v1.0.0. Three additions, then the fixes that change old results. The full changelog is in the v1.1.0 release notes.
- Large-wave forces. Nonlinear Froude-Krylov pressure on the wetted hull, chosen per body.
- Controllers. Another program reads the model and drives motors, springs and ropes. Demos: a winch, and a motion-compensated crane.
- A new viewer, on by default. Timeline, replay, live sea and PTO changes, force arrows, and radiated waves taken from the BEM data.
Run a demo
# Windows
bin\run_seastack.exe demos\crane\lift_3dmc
# macOS and Linux
./bin/run_seastack demos/crane/lift_3dmc
Also in the package:
demos/iea_sphere/regular_waves_nlfkis the large-wave spheredemos/iea_sphere/controller_winchis the winch- RM3, OSWEC, 5SA, trimaran, and the external PTO cases from v1.0.0
See QUICKSTART.txt.
Large waves
Nonlinear Froude-Krylov, chosen per body. Static and incident-wave pressure are integrated over the hull below the free surface. The linear Froude-Krylov part is removed from the BEM excitation. Radiation and diffraction stay linear.
Turn it on with:
wetted_surface: instantaneous- a body
mesh_file wave_pressure: airy_wheeler(default) orlong_wave
On the IEA OES Task 10 sphere:
- Steepness H/(gT²) = 0.01: heave RAO within 1% of the MARIN and NREL weakly nonlinear results, all 20 points, free and with optimum PTO
- T = 11 s with PTO: RAO 0.577, against 0.575 and 0.574. Linear theory gives 0.70
- Wave height from 0.5 m to 6 m: within 0.1% of linear below 1 m, and 4.2% different at 6 m
wetted_surface also names the v1.0.0 models. Leave it unset and the results stay as they were.
meanis linear hydrostatics and excitationcalm_wateris the v1.0.0 nonlinear hydrostatics- an existing
hydrostatics: nonlinearstill meanscalm_water
Controllers
A controller in its own process (preview). A controller_file lists what it reads and writes every control_dt:
- body motion
- motor angles and rates
- TSDA rest lengths
- RSDA rest angles
The Python helper uses the standard library only, and it can be tested without SEA-Stack. Any program that speaks the protocol works. This is separate from the v1.0.0 external PTO, which applies a force.
Ropes that can go slack. A ropes_file marks a TSDA as tension-only. It pulls, and the force is zero when the line is slack.
Demos:
- Winch. Hauls the IEA sphere up 0.49987 m, against 0.49985 m from the rope and waterplane in series.
- Crane. A 50 m workboat sets a 3 t payload on a fixed platform in irregular waves. With 3D motion compensation the mean tip error is 0.08 m and touchdown is at 0.07 m/s. Open loop is 1.14 m and 2.0 m/s.
On Linux, each external step was stalling about 40 ms. The length header and the JSON body were separate TCP writes, and Nagle's algorithm waited for an ACK. Each message is now one write, and both ends set TCP_NODELAY.
Channel names and the Python API may change. Guide: Controllers.
The viewer
SEA-Stack's viewer is the default.
- Scrub and replay the run so far, from 0.05× to 20× and at Max, then return to live
run_seastack --replay results.h5plays a recorded run with no Chrono process- Sliders for TSDA and RSDA stiffness, damping, and rest length or angle
- Sliders for wave height, period and direction, applied while the model runs
- Those changes are stored in the results file and repeated with
--schedule - Force and moment arrows, centre-of-mass trails, live plots, and click a body to isolate it
The sea on screen is the wave field.
- Directional seas are drawn from the 500 largest components. On the Wigley sea that is 96% of the elevation standard deviation. v1.0.0 drew the first 500 in the file, and that sea looked flat
- Elevation colouring, a sky reflection, and a grid sized from the wavelength
- Radiated waves come from the BEM radiation damping, or from the excitation through the Haskind relation when the file has enough headings
- That replaces the v1.0 overlay, which guessed the amplitude. The picture is not fed back into the forces
A run you do not change from the GUI has the same /results as --nogui. Replay data is always recorded, so files grow: RM3 irregular waves over 180 s goes from 9.4 MB to 12.5 MB. Mooring tensions and node positions follow --output-level.
The window starts at real time. enforce_realtime in the YAML is ignored, and the transport bar sets the speed. --viewer=chrono opens the v1.0 viewer. That viewer also opens, with a warning, if the new one cannot draw the model or cannot start.
Guide: The viewer.
Fixes that change answers
Cases these fixes do not touch still match v1.0.0. The demo regression suite agrees with RMSrel at most 1e-6.
Capytaine excitation phase was conjugated on the 5SA, trimaran and Wigley files. Capytaine uses e^(−iωt) and SEA-Stack e^(+iωt). The demo writers did not convert, so the excitation was time-reversed.
- Trimaran and Wigley files are converted in place
- The 5SA files are re-solved: 200 and 400 frequencies instead of 30, and 36 headings at 10° instead of 13 at 30°
- Convert your own files from those scripts once, with
scripts/fix_capytaine_excitation_phase.py
Linear forces now turn with heading. Restoring, radiation and excitation were applied on the fixed world axes. Roll and pitch are tilts about the yawed heading, so a few degrees of yaw put part of the pitch stiffness into roll.
- The Wigley in a spread sea rolled to 90° after about 200 s
- The same BEM coefficients are now applied in the heading frame and rotated back
- That run completes 600 s with roll up to about 4.6°
- At zero yaw the forces are unchanged
- Coefficients are not looked up again for the new heading. That is planned for v1.2
waves.direction now reaches IRF excitation and elevation records.
- An OSWEC at 30° used to match a run at 0°
- IRF and frequency-domain excitation now agree within 0.4% (normalised RMS of flap pitch)
- An
eta_filewith nodirectionis unchanged
A failed step returns exit code 1. A solver failure or an external-module timeout used to exit 0, so a truncated run looked like a success.
Also in this release
- Initial body velocity is documented:
initial_linear_velocity(centre of mass, world axes) andinitial_angular_velocity(body axes), with a decay test - An MHKiT/NDBC download that writes a hydro YAML wave block, and an HDF5 plotter with
--compare, contributed by Allie Riley (@alliemr123, #18). In the package, underdemos/features/ - The release ZIP contains only the shipped demos, and the package build checks that list
- Nonlinear hydrostatics in waves warns at start-up, and once per body if it fully emerges or submerges. The forces are unchanged
- Mesh submerged volume no longer depends on face winding when the waterplane is not at z = 0. Shipped cases use z = 0 and are bit-identical
Upgrading from v1.0.0
- Leave
wetted_surfaceunset and the hydrostatics and excitation stay on the v1.0.0 models - Re-run work that used the 5SA, trimaran or Wigley hydro files. Other shipped demos at zero yaw match v1.0.0
- Both Wigley demos now include a linear yaw damping of 1e7 N·m·s/rad. Without a yaw restraint, a free hull in linear theory can yaw without bound
- v1.0.0 results files have no
/visualizationgroup, so they cannot be replayed. The viewer says so - Nothing in a v1.0.0 setup file starts a controller or a rope. External PTO cases are unchanged apart from the socket fix above
Requirements
| Packages | Windows x64, macOS arm64, Linux x64 |
| Source builds | Chrono 10.0.0 exactly (build recipe) |
| Linux source builds | Chrono with CH_USE_SIMD=OFF and Eigen MAX_ALIGN / MAX_STATIC_ALIGN = 16 |
| External PTO, the winch and the crane | Python 3 on PATH |
| Controller and crane demos | A package built with the external-module option. Release packages are. |
Known limitations
- Nonlinear Froude-Krylov keeps linear radiation and diffraction about the mean position. It does not model slamming, green water, or the body disturbing the incident wave. Eta-table waves (
waves.method: irf_convolution) are not supported - Heading transport does not look up new BEM coefficients. Excitation still uses the world wave direction, and there is no mean drift force
- The trimaran hydro file has one heading, so its spread sea is applied as a head sea
- The controller interface is a preview: names and the Python API may change
- If the new viewer cannot start, the run falls back to the Chrono viewer and warns.
--viewer=chronoselects it. The Windows package for this commit has been through the release checks
The longer list is in th...
SEA-Stack v1.0.0
First stable release
SEA-Stack is an open-source C++ platform for offshore and marine energy simulation: YAML-driven cases, linear potential-flow hydrodynamics, multibody dynamics via Project Chrono, optional MoorDyn mooring, PTO/control models, HDF5 results, and a real-time 3D GUI.
This is the first stable v1.0.0 release of SEA-Stack. Download a package, extract, and run a demo without writing C++.
# Windows
bin\run_seastack.exe demos\rm3\decay
# macOS
./bin/run_seastack demos/rm3/decay
# Linux
./bin/run_seastack demos/rm3/decay
More demos under demos/ (RM3, OSWEC, IEA sphere, 5SA, trimaran, external PTO, …). See QUICKSTART.txt in the package.
What’s in the box
- Multibody offshore / WEC simulation (joints, FEA where used) on Chrono 10
- BEMIO HDF5 hydro: radiation (RIRF / state-space / opt-in constant-coefficient), excitation, linear & nonlinear hydrostatics
- Regular, irregular, bimodal, and directional waves; eta-file import
- Linear & hydraulic PTO, external/Python PTO hooks, power-matrix campaigns
- MoorDyn mooring with visualization
- Packaged Windows x64, macOS arm64, and Linux x64 runtimes
- Regression / verification / comparison test suites and worked demos
Highlights since the betas
- Trustworthy hydro defaults — excitation on non-uniform BEM grids fixed; state-space radiation now fits the full impulse response (results change for
radiation.method: state_space) - Opt-in constant-coefficient radiation for regular waves on a BEM grid frequency (
radiation.method: constant_coefficients) - YAML that used to fail silently now works or errors clearly — block-style hull damping, several wave/mooring list forms, better validation before stepping
- Downstream SDK / Eigen ABI — MSVC consumers inherit AVX2 alignment; Linux/macOS pin a portable 16/16 Eigen contract (Chrono must match — see docs)
- Relocatable packages — validated Windows x64, macOS arm64, and Linux x64 runtime packages
- GUI —
enforce_realtimehonoured again; radiation overlay scale-consistent - Platform — Linux runtime packaging and Chrono 10 source-build support; joint reactions exported for all joint types (incl. 5SA)
If you used beta / RC builds: state-space cases and the rm3/mooring demo baselines changed (full wave-record import). RIRF convolution on uniform BEM grids is unchanged.
Requirements
| Packages | Windows x64, macOS arm64, Linux x64 |
| Source builds | Chrono 10.0.0 exactly (build recipe) |
| Linux source builds | Chrono with CH_USE_SIMD=OFF and Eigen MAX_ALIGN / MAX_STATIC_ALIGN = 16 |
| External PTO demos | Python 3 on PATH |
Known limitations (short)
- CoM / BEM
cg/ MoorDyn origin must agree (not auto-checked yet) - Radiation GUI overlay is qualitative only
- Full list: RELEASE_NOTES_v1.0.0.md
Docs
- Technical overview
- Example workflows
- Full release notes (changelog-level detail)
Tag / commit: v1.0.0 → 576736de8e3efb5897f825e594d65ea23f26f092
License: MIT
SHA256 checksums
-
SEAStack-1.0.0-win64.zip
14623BF3D83DBFEAF16EEE48A212CED7FFC745020F91C04B122CD05BFE2D013B -
SEAStack-1.0.0-darwin-arm64.zip
214bb4f308827b93735efb76e15acdfd51af6a8df734bbd7ca6b4123d8cae5d4 -
SEAStack-1.0.0-linux-x64.zip
e53aef1e1d233dd9fc188d716427e4c84834c0418263df8bfca68ab96c47d9f1
SEA-Stack v1.0.0-beta.4
SEA-Stack v1.0.0-beta.4 is an updated public beta release of the SEA-Stack simulation platform.
Changes since v1.0.0-beta.3
- External PTO — Multiple
external_ptosattachments per setup, plus optionalcombine_nativeto run an external module together with a Chrono spring-damper. - MoorDyn orientation coupling — Chrono and MoorDyn compose roll/pitch/yaw in different orders. SEA-Stack now converts Chrono orientations into MoorDyn’s convention before each coupling step so fairleads stay correctly attached at large tilt, while keeping angles smooth between steps so RM3 fairlead tensions still match WEC-Sim.
- Hydro diagnostics — Divergence limits are configurable from hydro YAML; OSWEC demo added for that path.
- GUI — Simulation steps are paced in realtime; reaching
end_timepauses instead of exiting the app. YAML body opacity is preserved through the VSG material path (useful for translucent hulls). - Irregular waves — Default / demo spectral resolution raised to
n_omega: 512. Packaged demo baselines refreshed sotests/RUN-TESTSpasses on a clean ZIP extract. - Packaging — Version bumped to
v1.0.0-beta.4; Windows runtime staging includes the Chrono FSI TDPF VSG DLL where needed.
Beta release for early users and feedback. See the README for install/usage. Verification, regression, and comparison report PDFs are attached.
SEA-Stack v1.0.0-beta.3
SEA-Stack v1.0.0-beta.3 is an updated public beta release of the SEA-Stack simulation platform.
Changes since v1.0.0-beta.2
- External force / PTO modules — Added support for out-of-process Python PTO models over loopback IPC using
external_ptoYAML configuration. Supports TSDA (RM3) and RSDA (OSWEC) links through thePtoModuleAPI. - Demos and documentation — RM3 and OSWEC
external_ptodemos, plotting scripts, andEXTERNAL_FORCE_MODULES.mdare included in the release ZIP. - CLI — The case banner now displays the external PTO YAML file
- macOS — Fixed external PTO child-process launching, including
python3andPATHresolution. - Release process — Added
RELEASE_CHECKLIST.md. Report staging now expects PDF outputs generated using Pandoc and LaTeX.
This release provides
- Modular offshore and marine energy simulation capabilities
- Examples, demos, and documentation for getting started
- Packaged Windows and macOS builds with the VSG GUI
- YAML-driven simulation workflows through
run_seastack - External Python PTO examples, requiring Python 3 on
PATH - Updated downstream package and export support
Notes
- This is a beta release intended for early users, testing, and feedback.
- See the
READMEand documentation for installation, usage, and testing guidance. - This release includes automatically generated verification, regression, and comparison test reports.
- Packages and reports were generated from the current release branch state.
SEA-Stack v1.0.0-beta.2
SEA-Stack v1.0.0-beta.2 is an updated public beta release of the SEA-Stack simulation platform.
Changes since v1.0.0-beta.1
- VSG GUI in release packages - the beta.1 Windows ZIP was built headless-only; beta.2 packages include the Vulkan Scene Graph GUI. Use
--noguifor headless runs; visualization requires a Vulkan-capable GPU/driver. - Relative setup paths -
run_seastack.exe case.setup.yamlnow works from the case directory. - Packaging QA - Windows release builds verify compile-time VSG via
run_seastack --doctor. - macOS (arm64) - fix exception unwinding when linking Chrono.
- YAML / demos - restore eta-file
n_omegadefault; fixrm3_mooringdemo hydro YAML.
This release provides
- Modular offshore and marine energy simulation capabilities
- Examples, demos, and documentation for getting started
- Windows and macOS packaged builds (with VSG GUI)
- YAML-driven simulation workflows via
run_seastack - Updated downstream package/export support
Notes
- This is a beta release intended for early users, testing, and feedback
- See the README and documentation for installation, usage, and testing guidance
- This release includes automatically generated verification, regression, and comparison test reports
- Packages and reports were generated from the current
mainrelease state
SEA-Stack v1.0.0-beta.1
SEA-Stack v1.0.0-beta.1 is an updated public beta release of the SEA-Stack simulation platform.
This release provides:
- Modular offshore and marine energy simulation capabilities
- Examples, demos, and documentation for getting started
- Windows and macOS packaged builds
- YAML-driven simulation workflows via
run_seastack - Updated downstream package/export support
Notes:
- This is a beta release intended for early users, testing, and feedback
- See the README and documentation for installation, usage, and testing guidance
- This release includes automatically generated verification, regression, and comparison test reports
- Packages and reports were generated from the current
mainrelease state
SEA-Stack v1.0.0-beta
SEA-Stack v1.0.0-beta is the first beta release of the SEA-Stack simulation platform.
This release provides:
- Modular offshore and marine energy simulation capabilities
- Examples, demos, and documentation for getting started
- Windows and macOS packaged builds
- YAML-driven simulation workflows via
run_seastack
Notes:
- This is a beta release intended for early users, testing, and feedback
- See the README and documentation for installation, usage, and testing guidance
- This release includes automatically generated verification, regression, and comparison test reports