cabledyn 0.3.0__tar.gz

cabledyn-0.3.0/.gitattributes

@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: Apache-2.0
+# Enforce LF line endings for all text files on every platform so that
+# ruff format --check (configured for "lf") does not falsely flag files
+# checked out on Windows runners with core.autocrlf=true.
+#
+# Encoding policy: all tracked text (source, config, and Markdown docs) is
+# UTF-8. The docs use UTF-8 typographic and engineering glyphs (em dash,
+# multiplication sign, <=, Greek letters). They render correctly in any
+# UTF-8 terminal; on a legacy Windows console set the code page first with
+# `chcp 65001` (or `$OutputEncoding = [Text.Encoding]::UTF8` in PowerShell).
+# git stores/serves these bytes verbatim -- no working-tree-encoding rewrite.
+
+* text=auto eol=lf
+
+# Explicit text-with-LF for source / config types
+*.py        text eol=lf
+*.pyi       text eol=lf
+*.toml      text eol=lf
+*.yaml      text eol=lf
+*.yml       text eol=lf
+*.md        text eol=lf
+*.cff       text eol=lf
+*.txt       text eol=lf
+*.cfg       text eol=lf
+*.ini       text eol=lf
+*.f         text eol=lf
+*.f90       text eol=lf
+*.F90       text eol=lf
+LICENSE     text eol=lf
+
+# Binary and data formats. Marking Office files explicitly also prevent a
+# machine-wide Git text-conversion driver from treating them as source.
+*.pdf       binary
+*.npy       binary
+*.png       binary
+*.jpg       binary
+*.jpeg      binary
+*.docx      binary
+*.xlsx      binary
+*.xls       binary
+*.zip       binary
+
+# The OpenFAST integration patches are byte-exact upstream diffs. Preserve and
+# validate them as patch payloads rather than applying source whitespace rules.
+integration/openfast/patches/*.patch -whitespace

cabledyn-0.3.0/.gitignore

@@ -0,0 +1,105 @@
+# SPDX-License-Identifier: Apache-2.0
+# Research manuscripts and copyrighted literature are maintained separately.
+# These directories must never be committed to the software repository.
+papers/
+publication/
+
+# OpenFAST summary files are regenerable run output.
+*.sum
+
+# Local-only third-party source trees (OpenFAST, MoorDyn, and reference data)
+# kept for cross-reference during implementation. Never pushed.
+external/
+
+# Office documents
+*.docx
+
+# Python
+__pycache__/
+*.pyc
+*.pyd
+.pytest_cache/
+.pytest-tmp/
+.mypy_cache/
+.ruff_cache/
+*.egg-info/
+validation/**/work/
+
+# Coverage
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+fortran-coverage.xml
+fortran-coverage.html
+fortran-coverage/
+
+# Fortran build artefacts
+*.mod
+*.o
+*.a
+*.so
+*.dll
+*.dylib
+
+# Build / dist trees (any build*/ tree: build/, build-coverage/, build_relcheck/, ...)
+build*/
+.build*/
+stage*/
+dist/
+_skbuild/
+
+# Sphinx documentation build output
+doc/_build/
+
+# IDE / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db
+
+# Benchmark binaries / native executables (large, regenerable)
+*.npy
+*.exe
+
+# Environment files
+.env
+.envrc
+
+# Fortran driver test scratch (written to cwd when test_cable_driver or the
+# cabledyn_driver executable run outside the build dir)
+driver_*.inp
+driver_*.csv
+
+# Deck-driver / C-API / aggregate / sweep test scratch (written to cwd when the test
+# executables or the cabledyn deck driver run outside the build dir). None of
+# these collide with the tracked examples/ decks (wd0050_chain, composite_*,
+# iea15mw_volturnus_mooring).
+deck_*.dat
+deck_*.out
+deck_*.xyz
+deck_*.txt
+deck_sub/
+# Long-path regression directory written by test_deck_driver.
+deck_motion_overflow_subdirectory_0123456789/
+capi_*.dat
+fmf_*.dat
+hfmf_*.dat
+agg_*.dat
+agg_*.out
+agg_*.xyz
+scratch_*.out
+lozon80_*.out
+owc_test.dat
+syrope.dat
+wk_*.dat
+*.Line.*.out
+*.Rod.*.out
+*.FarmCD.out
+*_guard_sweep.out
+
+# Local portable test-drive package (binaries + mingw OpenBLAS; regenerable)
+test_drive/
+
+# Regenerable release staging directories (published assets live on GitHub).
+dist*/

cabledyn-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+# File: .pre-commit-config.yaml
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) 2026 Jae Hoon Seo, SMI Lab, Inha University
+#
+# Hooks run locally on every commit. CI does NOT invoke `pre-commit` itself --
+# fortran.yml runs the equivalent gates as explicit steps: the fprettify
+# formatting check plus the CMake build and CTest suite. Keep this list and
+# that workflow in sync so a hook that passes locally is also enforced in CI.
+
+repos:
+  # src/openfast/ carries OpenFAST-convention sources kept byte-exact against their
+  # upstream/registry-generated forms. The OpenFAST integration patches are also
+  # byte-exact upstream diffs. Whitespace normalizers must not rewrite either group.
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: ^(src/openfast/|integration/openfast/patches/)
+      - id: end-of-file-fixer
+        exclude: ^(src/openfast/|integration/openfast/patches/)
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: check-added-large-files
+        args: [--maxkb=2000]
+
+  - repo: https://github.com/fortran-lang/fprettify
+    rev: v0.3.7
+    hooks:
+      - id: fprettify
+        args: [--indent, "2", --line-length, "120"]
+        # src/openfast/ carries OpenFAST-convention sources: CableDyn_Types.f90 is
+        # registry-generated (must stay byte-exact vs regeneration) and the module
+        # glue follows OpenFAST formatting for review against the upstream modules.
+        exclude: ^src/openfast/
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.13
+    hooks:
+      # No --config: ruff discovers python/pyproject.toml per file, so its relative
+      # settings (per-file ignores, first-party detection) resolve against python/.
+      - id: ruff-check
+        files: ^python/
+      - id: ruff-format
+        files: ^python/
+
+  - repo: local
+    hooks:
+      - id: release-metadata
+        name: release metadata
+        entry: python release/check_release_metadata.py
+        # Let pre-commit provide the interpreter. This avoids relying on a
+        # system-level `python` command, which is commonly absent on Windows.
+        language: python
+        pass_filenames: false

cabledyn-0.3.0/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) 2026 Jae Hoon Seo, SMI Lab, Inha University
+# Read the Docs build configuration for CableDyn.
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: doc/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - requirements: doc/requirements.txt
+    - method: pip
+      path: python
+
+# Offer the manual as downloadable PDF and EPUB alongside the HTML site.
+formats:
+  - pdf
+  - epub