Skip to content

docs(readme): lead with what CableDyn does and the evidence for it - #120

Merged
SMI-Lab-Inha merged 2 commits into
devfrom
docs/readme-capabilities
Nov 9, 2026
Merged

SMI-Lab-Inha merged 2 commits into
devfrom
docs/readme-capabilities

Conversation

@SMI-Lab-Inha

Copy link
Copy Markdown
Owner

The README opened with the input format and a feature table. It now:

  • opens with what CableDyn resolves: curvature along the line, under a bend stiffener, through a lazy wave and across a moving touchdown, together with tension, torque and twist;
  • lists what it does: finite-element cables with bending stiffness and fourth-order curvature, the implicit step, bend stiffeners and section curvature, torsion, statics from the geometry alone, coupled analysis with linearisation, modes, VIV, and in-process hosts;
  • backs each claim with a measured comparison from the validation record: closed forms, OrcaFlex 11.6d, the Holcombe and Bergdahl model tests, and OpenFAST;
  • adds run times on one thread, same host and protocol;
  • turns MoorDyn-format input into a short "Coming from MoorDyn" migration note.

Every figure is quoted from VALIDATION.md. The run times come from the performance records re-measured in #118, so this PR should merge after #118.

@SMI-Lab-Inha

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-08T22:51:05.278119Z bdafca7 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@read-the-docs-community

read-the-docs-community Bot commented Nov 8, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 CableDyn | 🛠️ Build #35740864 | 📁 Comparing bdafca7 against latest (e8f88f5)

  🔍 Preview build  

11 files changed · ± 11 modified

± Modified

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b1f5b3ef8b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Resolved
Comment thread README.md Resolved
The README opened with the deck format and a feature table. It now says what
the solver resolves, lists what it does (finite-element cables with bending
stiffness and fourth-order curvature, the implicit step, bend stiffeners and
section curvature, torsion, statics from the geometry alone, coupled analysis
with linearisation, modes, VIV, in-process hosts), and backs each with a
measured comparison: closed forms, OrcaFlex 11.6d, two model tests, OpenFAST,
and run times on one thread from the committed timing scripts. Reading
MoorDyn-format decks becomes a migration note.

Signed-off-by: Jae Hoon Seo <jaehoon.seo@inha.ac.kr>
The L1-10 test measures the deflection of a beam under its weight against
the Euler-Bernoulli quartic, not the curvature: the README now says so, and
that the slope (not the curvature) is continuous across the nodes.

Signed-off-by: Jae Hoon Seo <jaehoon.seo@inha.ac.kr>
@SMI-Lab-Inha
SMI-Lab-Inha force-pushed the docs/readme-capabilities branch from 36ddb3c to bdafca7 Compare November 8, 2026 22:49
@SMI-Lab-Inha

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🚀

Reviewed commit: bdafca78f8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@SMI-Lab-Inha
SMI-Lab-Inha merged commit c107545 into dev Nov 9, 2026
16 checks passed
@SMI-Lab-Inha
SMI-Lab-Inha deleted the docs/readme-capabilities branch November 9, 2026 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant