cabledyn: Python tools for CableDyn

cabledyn is for engineers who script CableDyn analyses. It runs the standalone solver, reads and post-processes results, validates and edits input decks, runs parameter studies, and couples to the solver in-process through the C interface. The full reference is the Python chapter of the CableDyn manual.

Install

From PyPI (Python 3.10 or newer; NumPy is the only required dependency):

py -m pip install cabledyn
py -m pip install "cabledyn[post]"   # adds pandas and matplotlib

The wheels for Windows x64, Linux x86-64 (both for processors with AVX2) and macOS on Apple silicon carry the solver: the CableDyn shared library for the in-process CableDyn class and the standalone driver that CableDynDriver and cabledyn-run run. On another platform pip builds from the source distribution, which needs a Fortran compiler and LAPACK.

The pure Python wheel attached to each GitHub release (cabledyn-0.3.0-py3-none-any.whl) carries no solver. CableDynDriver finds the driver from an explicit path, then the CABLEDYN_DRIVER environment variable, then the driver inside the package, then PATH; the in-process CableDyn class uses the library inside the package, or one named by CABLEDYN_LIBRARY or found in a source checkout's build tree.

Components

Example

from cabledyn import CableDynDriver

driver = CableDynDriver(r"C:\CableDyn\CableDyn_driver.exe")
result = driver.run("model.dat", "results/baseline", timeout=600)

history = result.read_main()
print(history.statistics("FairTen1")[0])

fatigue = history.fatigue("FairTen1", start=600.0, stop=4200.0,
                          wohler_exponent=3.0, reference_frequency=1.0, bins=32)
print(fatigue.damage_equivalent_range)

profile = result.read_static()
profile.plot("Curvature", line_id=1)

A returned result is always a converged analysis: a failed solver step, timeout, missing output, or malformed or non-finite data raises a typed exception. Existing results are kept unless overwrite=True, and then restored if the new run fails.

Run a generated study from the command line:

cabledyn-study generated\cases.json --executable C:\CableDyn\CableDyn_driver.exe `
  --output-directory generated\results --jobs 4 --channel FairTen1 --start 600 --stop 4200

cabledyn-study exits 1 if any case failed, 2 for an invalid manifest or unsafe destination, and 3 if the cases ran but study.json or summary.csv could not be written.

Documentation

• Python guide
• Post-processing
• API reference
• Command-line tools

Licensed under the Apache License 2.0.