Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
928 changes: 86 additions & 842 deletions CHANGELOG.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ authors:
repository-code: "https://github.com/SMI-Lab-Inha/CableDyn"
url: "https://github.com/SMI-Lab-Inha/CableDyn"
license: Apache-2.0
version: 0.1.1
date-released: 2026-10-09
version: 0.2.0
date-released: 2026-10-20
keywords:
- mooring dynamics
- cable dynamics
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#
cmake_minimum_required(VERSION 3.20)
# VERSION is a bare numeric triple matching the release version.
project(CableDynCore VERSION 0.1.1 LANGUAGES C Fortran
project(CableDynCore VERSION 0.2.0 LANGUAGES C Fortran
DESCRIPTION "CableDyn geometrically nonlinear cable/mooring solver — Fortran core")

option(CABLEDYN_ENABLE_COVERAGE "Instrument the GNU Fortran core for gcov/gcovr source coverage" OFF)
Expand Down
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ in the MoorDyn v2 format and solves them with two line formulations:
- **Finite-bending lines** (finite-EI): cubic-Hermite elements for dynamic power
cables, including lazy-wave configurations, with continuous centreline curvature.

The current stable release is `v0.1.1`. Interfaces are
The current stable release is `v0.2.0`. Interfaces are
versioned and may change before `1.0.0`.

## Capabilities
Expand All @@ -48,8 +48,8 @@ a named error rather than running approximately.
|---|---|
| `CableDyn_driver.exe` | Standalone solver for Windows x64 |
| `openfast.exe` | OpenFAST with CableDyn available as `CompMooring = 5` |
| `cabledyn-0.1.1-py3-none-any.whl` | Python package (pre- and post-processing, batch runs) |
| `cabledyn-0.1.1.tar.gz` | Python source distribution |
| `cabledyn-0.2.0-py3-none-any.whl` | Python package (pre- and post-processing, batch runs) |
| `cabledyn-0.2.0.tar.gz` | Python source distribution |
| `SHA256SUMS.txt` | Checksums for the assets above |

Both executables are statically linked, need no installer, compiler, or runtime
Expand Down Expand Up @@ -82,7 +82,7 @@ a named error rather than running approximately.
this run writes `examples\wd0050.out`:

```powershell
python -m pip install "cabledyn-0.1.1-py3-none-any.whl[post]"
python -m pip install "cabledyn-0.2.0-py3-none-any.whl[post]"
cabledyn-run examples\wd0050_chain.dat wd0050 --executable .\CableDyn_driver.exe
```

Expand All @@ -92,8 +92,8 @@ a named error rather than running approximately.

For OpenFAST, set `CompMooring = 5` in the `.fst` file and point `MooringFile` at
a CableDyn deck; ready-to-run cases are in
[`examples/openfast`](examples/openfast/README.md). Every shipped deck is listed
in [`examples/`](examples/README.md).
[`examples/openfast`](https://cabledyn.readthedocs.io/en/latest/tutorial_openfast.html). Every shipped deck is listed
in [`examples/`](https://cabledyn.readthedocs.io/en/latest/examples.html).

## Documentation

Expand All @@ -115,18 +115,18 @@ The driver is `build/cabledyn` (`build\bin\cabledyn.exe` with the conda toolchai
on Windows); the release
ships the same program as `CableDyn_driver.exe`.

See [DEVELOPMENT.md](DEVELOPMENT.md) for the full test suite, the Python package,
and the OpenFAST build, and [ARCHITECTURE.md](ARCHITECTURE.md) for the source
layout.
See the [development guide](https://cabledyn.readthedocs.io/en/latest/development.html)
for the full test suite, the Python package, and the OpenFAST build; the source
layout is described in the architecture notes in the repository.

## Validation

CableDyn is verified against analytical solutions and compared with MoorDyn,
OrcaFlex, two physical experiments (Holcombe lazy-wave, Bergdahl dynamic chain),
the IEA 15 MW VolturnUS-S reference systems, and coupled OpenFAST runs. Results,
acceptance criteria, and reproduction commands are in
[VALIDATION.md](VALIDATION.md); data and scripts are in
[`validation/`](validation/README.md).
the [validation record](https://cabledyn.readthedocs.io/en/latest/validation.html); data and scripts are in
[`validation/`](https://cabledyn.readthedocs.io/en/latest/validation.html).

## Repository layout

Expand All @@ -151,19 +151,21 @@ If you use CableDyn in academic work, please cite:
> offshore wind. *Ocean Engineering* 368 (Part 2), 128332, 2026.
> <https://doi.org/10.1016/j.oceaneng.2026.128332>

To identify the software version, also cite the release (CableDyn 0.1.1).
[CITATION.cff](CITATION.cff) contains both entries (GitHub **Cite this
To identify the software version, also cite the release (CableDyn 0.2.0).
The [citation file](https://cabledyn.readthedocs.io/en/latest/citing.html) contains both entries (GitHub **Cite this
repository**); BibTeX is on the manual's
[How to cite](https://cabledyn.readthedocs.io/en/latest/citing.html) page.

## Contributing and support

Questions, bug reports, and feature requests are welcome in
[GitHub Issues](https://github.com/SMI-Lab-Inha/CableDyn/issues); see
[SUPPORT.md](SUPPORT.md) for where each belongs. Read
[CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Everyone taking
part is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md). Report
security issues privately as described in [SECURITY.md](SECURITY.md).
[GitHub Issues](https://github.com/SMI-Lab-Inha/CableDyn/issues); the
support notes in the repository say where each belongs. Read the
[contributing guide](https://cabledyn.readthedocs.io/en/latest/contributing.html)
before opening a pull request. Everyone taking part is expected to follow the
[Code of Conduct](https://github.com/SMI-Lab-Inha/CableDyn?tab=coc-ov-file). Report
security issues privately as described in the
[security policy](https://github.com/SMI-Lab-Inha/CableDyn/security/policy).

If you extend or fix CableDyn in your own copy, please consider contributing the
change here, so that every user benefits and the validation record stays in one
Expand All @@ -181,7 +183,7 @@ CableDyn builds on the work of others, and we are grateful to the developers and
maintainers of MoorDyn (Hall et al.), whose open input format CableDyn reads and
which serves as a comparison reference; of OpenFAST (NLR), which hosts CableDyn as
a mooring module; and of OrcaFlex, the industry reference used for many of the comparisons
in [VALIDATION.md](VALIDATION.md). OrcaFlex is a product of Orcina Ltd.
in the [validation record](https://cabledyn.readthedocs.io/en/latest/validation.html). OrcaFlex is a product of Orcina Ltd.

## License and name

Expand All @@ -193,3 +195,9 @@ are welcome under the licence, but, as Section 6 of the Apache License 2.0
provides, they may not use the name in a way that implies they are the official
CableDyn or endorsed by its maintainers; describing a work as "based on CableDyn"
is fine.

This software is developed independently at the Department of Naval Architecture
and Ocean Engineering, Inha University. It is not affiliated with, derived from,
or endorsed by the EPSRC-funded research project (2022–2025) of the same name
led by the University of Edinburgh, "CableDyn: Subsea Power Cable Dynamics Under
Complex Ocean Environment" ([cabledyn.eng.ed.ac.uk](https://cabledyn.eng.ed.ac.uk)).
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ where practical), and keep the workflow URL with the release record.
Tag only the commit that passed every check:

```powershell
$ReleaseVersion = "0.1.1"
$ReleaseVersion = "0.2.0"
git tag -s "v$ReleaseVersion" -m "CableDyn v$ReleaseVersion"
git push origin "v$ReleaseVersion"
```
Expand Down
6 changes: 1 addition & 5 deletions VALIDATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,11 +291,7 @@ scripts, results, and source provenance are in
over the full 30-condition period-radius matrix, cycle-maximum upper-end force
has RMSE 1.58 N, mean absolute percentage error 3.13%, Pearson correlation
0.993, and Lin concordance 0.989. Two phase-averaged measured histories have
waveform RMSEs of 5.95% and 2.54% of their force ranges; these two were computed with the
executable of the 2026-10-09 record (the configuration-blended `EI = 0` step, without
sub-steps), because the
article supplement's `expData.dat` they need was not available for the rerun (see the
experiment's README and `provenance.json`). Halving the mesh length
waveform RMSEs of 5.93% and 2.56% of their force ranges. Halving the mesh length
and the time step changes the mean cycle maximum by at most 0.56% and 0.19%. The
0.3125 ms step resolves the segment axial modes that the snap loads excite (and the axial
wave over a segment, so the matrix takes no rotation- and snap-resolved sub-step and equals
Expand Down
8 changes: 4 additions & 4 deletions doc/capi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,12 @@ files directly, as shown below.
- Library files
- Header
* - Linux
- ``lib/libcabledyn.so.0.1.1``, the soname link ``libcabledyn.so.1``, and the development
- ``lib/libcabledyn.so.0.2.0``, the soname link ``libcabledyn.so.1``, and the development
link ``libcabledyn.so``. ``lib`` is the platform ``CMAKE_INSTALL_LIBDIR``, which can be
``lib64`` or a multiarch directory.
- ``include/CableDyn_CAPI.h``
* - macOS
- ``lib/libcabledyn.0.1.1.dylib``, ``lib/libcabledyn.1.dylib``, ``lib/libcabledyn.dylib``
- ``lib/libcabledyn.0.2.0.dylib``, ``lib/libcabledyn.1.dylib``, ``lib/libcabledyn.dylib``
- ``include/CableDyn_CAPI.h``
* - Windows, GNU toolchain
- ``bin/libcabledyn.dll`` and the import library ``lib/libcabledyn.dll.a``. The GNU
Expand Down Expand Up @@ -245,7 +245,7 @@ ABI and versioning
- the same four numbers, reported by the loaded library
* - ``CableDyn_GetVersionString``
- runtime
- ``"CableDyn 0.1.1 C-ABI 1"``
- ``"CableDyn 0.2.0 C-ABI 1"``
* - shared-library ``SOVERSION``
- 1
- soname ``libcabledyn.so.1`` or install name ``libcabledyn.1.dylib``. The Windows DLL
Expand Down Expand Up @@ -732,7 +732,7 @@ Version queries
- ``char *``
- ``version_len``
- yes: no-op
- receives ``"CableDyn 0.1.1 C-ABI 1"``, truncated to ``version_len - 1`` characters and
- receives ``"CableDyn 0.2.0 C-ABI 1"``, truncated to ``version_len - 1`` characters and
``NUL``-terminated
* - ``version_len``
- in
Expand Down
6 changes: 3 additions & 3 deletions doc/citing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,21 @@ Software release
----------------

Seo, J. H. (2026). *CableDyn: A cable and mooring dynamics solver for floating offshore
wind* (version 0.1.1) [Computer software]. https://github.com/SMI-Lab-Inha/CableDyn
wind* (version 0.2.0) [Computer software]. https://github.com/SMI-Lab-Inha/CableDyn

.. code-block:: bibtex

@software{CableDyn_0_1_1,
author = {Seo, Jae Hoon},
title = {{CableDyn}: A cable and mooring dynamics solver for floating offshore wind},
version = {0.1.1},
version = {0.2.0},
year = {2026},
url = {https://github.com/SMI-Lab-Inha/CableDyn},
license = {Apache-2.0}
}

When results depend on a particular release, quote the version reported in the solver banner
(``CableDyn v0.1.1``) together with the options recorded for the run.
(``CableDyn v0.2.0``) together with the options recorded for the run.

Relation to the journal article
-------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/coupling_boundary.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Rules shared by every entry point:

The interface ships as the versioned shared library `libcabledyn` (`cabledyn.dll` in an Intel
Fortran and MSVC build; CMake target `cabledyn_shared`) with the installed header; it reports
CableDyn 0.1.1 and C ABI version 1, minor extension 2. The Python package uses the same library.
CableDyn 0.2.0 and C ABI version 1, minor extension 2. The Python package uses the same library.

### Concurrency

Expand Down
18 changes: 14 additions & 4 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ with MoorDyn-C, MoorDyn-F, and OrcaFlex on common reference cases.
.. admonition:: Release status
:class: note

CableDyn ``v0.1.1`` is the current stable release. It adds torsion of finite-EI cables to
the first public release and makes the Windows builds more robust.
CableDyn ``v0.2.0`` is the current stable release. It adds active tensioning and coupled
torsion of finite-EI cables, sub-stepping of tension-only lines through snaps and seabed
friction in the static solve, and recovers node results from nodal equilibrium.
Every comparative-accuracy statement is linked to a passing benchmark in :doc:`validation`.
The project remains below ``1.0.0``, so public APIs may evolve between minor releases.

Expand Down Expand Up @@ -49,8 +50,8 @@ Download to first result in five minutes
----------------------------------------

#. Download ``CableDyn_driver.exe``, ``SHA256SUMS.txt``, and **Source code (zip)** (for the
``examples`` folder) from the `v0.1.1 release
<https://github.com/SMI-Lab-Inha/CableDyn/releases/tag/v0.1.1>`_ and verify the checksum —
``examples`` folder) from the `v0.2.0 release
<https://github.com/SMI-Lab-Inha/CableDyn/releases/tag/v0.2.0>`_ and verify the checksum —
:doc:`installation`. No installer and no runtime DLLs.
#. Put ``CableDyn_driver.exe`` in a working folder, unzip the source archive, and copy its
``examples`` folder next to the executable.
Expand Down Expand Up @@ -161,6 +162,15 @@ How to cite
If CableDyn contributes to published work, cite the method article and the software release
as described in :doc:`citing`.

Name
----

This software is developed independently at the Department of Naval Architecture and Ocean
Engineering, Inha University. It is not affiliated with, derived from, or endorsed by the
EPSRC-funded research project (2022--2025) of the same name led by the University of Edinburgh,
"CableDyn: Subsea Power Cable Dynamics Under Complex Ocean Environment"
(`cabledyn.eng.ed.ac.uk <https://cabledyn.eng.ed.ac.uk>`_).

.. toctree::
:hidden:
:caption: Getting started
Expand Down
26 changes: 13 additions & 13 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Installation
There are two ways to get CableDyn:

* **Windows release (recommended for users).** Two single-file executables and a Python wheel,
attached to the `v0.1.1 GitHub release
<https://github.com/SMI-Lab-Inha/CableDyn/releases/tag/v0.1.1>`_. No installer, no compiler,
attached to the `v0.2.0 GitHub release
<https://github.com/SMI-Lab-Inha/CableDyn/releases/tag/v0.2.0>`_. No installer, no compiler,
and no runtime DLLs. Start here if you want a first result in five minutes.
* **Build from source** (Windows, Linux, macOS). Needed for the C/Python in-process API, for
development, and on every platform other than Windows x64.
Expand Down Expand Up @@ -35,10 +35,10 @@ What is on the release page
- OpenFAST v5.0.0 (maintained by NLR, the National Laboratory of the Rockies, formerly
NREL) with CableDyn built in as ``CompMooring = 5``; stock MoorDyn
(``CompMooring = 3``) is still available in the same binary (:doc:`openfast`)
* - ``cabledyn-0.1.1-py3-none-any.whl``
* - ``cabledyn-0.2.0-py3-none-any.whl``
- the pure-Python package: deck editing, case generation, driver automation, result
readers, fatigue and spectral post-processing (:doc:`python`)
* - ``cabledyn-0.1.1.tar.gz``
* - ``cabledyn-0.2.0.tar.gz``
- the Python source distribution (same package as the wheel)
* - ``SHA256SUMS.txt``
- SHA-256 checksums of the four files above
Expand All @@ -56,7 +56,7 @@ Download and verify
~~~~~~~~~~~~~~~~~~~

1. Create a folder, for example ``C:\CableDyn``, and download into it ``CableDyn_driver.exe``,
``openfast.exe`` (only if you will couple with OpenFAST), ``cabledyn-0.1.1-py3-none-any.whl``
``openfast.exe`` (only if you will couple with OpenFAST), ``cabledyn-0.2.0-py3-none-any.whl``
(only if you will use Python), ``SHA256SUMS.txt``, and ``Source code (zip)``.
2. Verify every downloaded asset against ``SHA256SUMS.txt`` in PowerShell:

Expand All @@ -76,8 +76,8 @@ Download and verify

OK CableDyn_driver.exe
OK openfast.exe
OK cabledyn-0.1.1-py3-none-any.whl
not downloaded cabledyn-0.1.1.tar.gz
OK cabledyn-0.2.0-py3-none-any.whl
not downloaded cabledyn-0.2.0.tar.gz

``not downloaded`` only reports an asset you chose to skip.

Expand All @@ -86,7 +86,7 @@ Download and verify
``(Get-FileHash .\CableDyn_driver.exe -Algorithm SHA256).Hash`` with its line in
``SHA256SUMS.txt`` (the comparison is case-insensitive).

3. Unzip ``Source code (zip)``. It expands to a folder such as ``CableDyn-0.1.1``; copy (or move)
3. Unzip ``Source code (zip)``. It expands to a folder such as ``CableDyn-0.2.0``; copy (or move)
its ``examples`` folder into ``C:\CableDyn`` so the layout is::

C:\CableDyn\
Expand All @@ -112,7 +112,7 @@ Check that it runs
.. code-block:: text

===================================================================
CableDyn v0.1.1
CableDyn v0.2.0
Geometrically nonlinear cable & mooring dynamics for floating wind
(lazy-wave power cables and taut / semi-taut / catenary moorings)
-------------------------------------------------------------------
Expand Down Expand Up @@ -158,9 +158,9 @@ Python 3.10 or newer:

.. code-block:: powershell

py -m pip install .\cabledyn-0.1.1-py3-none-any.whl
py -m pip install .\cabledyn-0.2.0-py3-none-any.whl
# optional extras for DataFrames and plots:
py -m pip install ".\cabledyn-0.1.1-py3-none-any.whl[post]"
py -m pip install ".\cabledyn-0.2.0-py3-none-any.whl[post]"

This installs the ``cabledyn`` package and four console commands: ``cabledyn-run``,
``cabledyn-deck``, ``cabledyn-study``, and ``cabledyn-post``.
Expand Down Expand Up @@ -188,7 +188,7 @@ Check the installation from a new terminal:

.. code-block:: text

0.1.1 C:\CableDyn\CableDyn_driver.exe
0.2.0 C:\CableDyn\CableDyn_driver.exe

The in-process API (``cabledyn.CableDyn``, stepping the solver from Python without a
subprocess) additionally needs the shared library from a source build; see :doc:`python`.
Expand Down Expand Up @@ -259,7 +259,7 @@ The script downloads the LAPACK source from its release tag and verifies its SHA
integration to OpenFAST itself (do not pre-apply it), builds
both executables, rejects any non-system DLL import, runs a standalone and a coupled
``CompMooring = 5`` / ``CompMooring = 3`` smoke case with a system-only ``PATH``, and writes
``SHA256SUMS.txt`` into ``build-static-release\dist``. The v0.1.1 assets were built from
``SHA256SUMS.txt`` into ``build-static-release\dist``. The v0.2.0 assets were built from
OpenFAST revision ``2895884d2be01862173c88d70f86b358d2f1a50a`` and smoke-tested against
``r-test`` revision ``dd5feaaaa500ba7283140107806300d551cff0a7``.

Expand Down
5 changes: 3 additions & 2 deletions doc/modeling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,9 @@ performance comparisons keep the default.

Choose ``dtM`` by convergence of peaks, phase, rainflow ranges, and accumulated damage—not only by
solver success. Numerical stability at a large implicit step is not evidence of fatigue accuracy.
In OpenFAST the default target is ``dtM = 0.1 s``; loads and assembled OpenFAST channels are
zero-order-held between CableDyn solves. The separate ``.CD.out`` contains only genuine committed
In OpenFAST the default is ``dtM = DT`` (a solve every glue step); with a larger deck ``dtM``,
loads and assembled OpenFAST channels are zero-order-held between CableDyn solves, which delays
the loads by about ``dtM/2`` (see :doc:`openfast`). The separate ``.CD.out`` contains only genuine committed
``dtM`` samples, while ``DT_Out`` changes the assembled OpenFAST recording cadence only. Neither
file convention substitutes for a time-step convergence study, which should cover the forcing
bandwidth, the shortest element transit time, contact switching, and constitutive relaxation
Expand Down
Loading
Loading