Skip to content

docs: describe CableDyn as geometrically exact, not geometrically nonlinear - #58

Merged
SMI-Lab-Inha merged 1 commit into
devfrom
docs/tagline
Oct 27, 2026
Merged

SMI-Lab-Inha merged 1 commit into
devfrom
docs/tagline

Conversation

@SMI-Lab-Inha

Copy link
Copy Markdown
Owner

The run banner said "Geometrically nonlinear cable & mooring dynamics for floating wind". That undersells the formulation. Both line elements use the exact large-deformation axial strain (ε = |r′| − 1) and curvature (κ = |r′ × r″| / |r′|³), never linearised. This PR changes every place that describes CableDyn so it matches the repository description: "geometrically exact finite-element statics and dynamics of mooring lines and dynamic power cables (for floating offshore wind)".

Changes:

  • Run banner (CableDyn_Banner.f90), lines 3–4. Width is unchanged and each line is at most 68 characters. The copies in installation.rst and quickstart.rst are updated.
  • OpenFAST identity line (CableDyn_OF.f90, WrScr), and its copy in tutorial_openfast.rst.
  • README intro and the manual landing page (index.rst). Both now state that the strain and curvature are the exact measures; the manual links to theory.
  • Citation:
    • the CITATION.cff title and abstract, and the citing.rst reference and BibTeX;
    • the BibTeX key now names the version it cites (CableDyn_0_1_1 → CableDyn_0_3_0).
  • Package metadata: the CMake project DESCRIPTION, the description in both pyproject.toml files, and the cabledyn package docstring.
  • CHANGELOG entry.

Wording only. No numerics change.

Checks:

  • ctest 305/305 and pytest against the built driver (2092 passed);
  • docs build with -W; ruff clean;
  • OpenFAST built with this branch's CableDyn module, so the CableDyn_OF.f90 line compiles.

…linear

The run banner said "Geometrically nonlinear cable & mooring dynamics for
floating wind", which undersells the formulation: both line elements use
the exact large-deformation axial strain and curvature, never
linearised. The banner, the OpenFAST identity line, README, the manual's
landing page and banner copies, CITATION.cff and the citing page, the
CMake project and the Python package descriptions now read "geometrically
exact finite-element statics and dynamics of mooring lines and dynamic
power cables (for floating offshore wind)", matching the repository
description. The software BibTeX key now names the version it cites.

Signed-off-by: Jae Hoon Seo <jaehoon.seo@inha.ac.kr>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Codex Review Summary

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

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-27T07:26:31.633885Z 48c3965 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.

@SMI-Lab-Inha

Copy link
Copy Markdown
Owner Author

@codex review

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 CableDyn | 🛠️ Build #35435370 | 📁 Comparing 48c3965 against latest (fd1936d)

  🔍 Preview build  

22 files changed · ± 22 modified

± Modified

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Chef's kiss.

Reviewed commit: 48c39651ff

ℹ️ 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 d7bfaae into dev Oct 27, 2026
21 checks passed
@SMI-Lab-Inha
SMI-Lab-Inha deleted the docs/tagline branch October 27, 2026 08:44
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