ropesim 0.1.0__tar.gz

ropesim-0.1.0/Cargo.lock

@@ -0,0 +1,232 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "crossbeam-deque"
+version = "0.8.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9dd111b7b7f7d55b72c0a6ae361660ee5853c9af73f70c3c2ef6858b950e2e51"
+dependencies = [
+ "crossbeam-epoch",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-epoch"
+version = "0.9.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5b82ac4a3c2ca9c3460964f020e1402edd5753411d7737aa39c3714ad1b5420e"
+dependencies = [
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-utils"
+version = "0.8.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28"
+
+[[package]]
+name = "either"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f402062616ab18202ae8319da13fa4279883a2b8a9d9f83f20dbade813ce1884"
+dependencies = [
+ "cfg-if",
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b14b5775b5ff446dd1056212d778012cbe8a0fbffd368029fd9e25b514479c38"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ab5bcf04a2cdcbb50c7d6105de943f543f9ed92af55818fd17b660390fc8636"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fd24d897903a9e6d80b968368a34e1525aeb719d568dba8b3d4bfa5dc67d453"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "36c011a03ba1e50152b4b394b479826cad97e7a21eb52df179cd91ac411cbfbe"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rayon"
+version = "1.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fb39b166781f92d482534ef4b4b1b2568f42613b53e5b6c160e24cfbfa30926d"
+dependencies = [
+ "either",
+ "rayon-core",
+]
+
+[[package]]
+name = "rayon-core"
+version = "1.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "22e18b0f0062d30d4230b2e85ff77fdfe4326feb054b9783a3460d8435c8ab91"
+dependencies = [
+ "crossbeam-deque",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "ropesim-rustcore"
+version = "0.1.0"
+dependencies = [
+ "pyo3",
+ "rayon",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.12.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"

ropesim-0.1.0/Cargo.toml

@@ -0,0 +1,3 @@
+[workspace]
+members  = ["ropesim/_rustcore"]
+resolver = "2"

ropesim-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ropesim contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ropesim-0.1.0/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: ropesim
+Version: 0.1.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Typing :: Typed
+Requires-Dist: numpy>=1.26
+Requires-Dist: pydantic>=2.0
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: pyside6>=6.6 ; extra == 'all'
+Requires-Dist: pytest>=7.4 ; extra == 'all'
+Requires-Dist: pytest-benchmark>=4.0 ; extra == 'all'
+Requires-Dist: maturin>=1.5 ; extra == 'all'
+Requires-Dist: pytest>=7.4 ; extra == 'dev'
+Requires-Dist: pytest-benchmark>=4.0 ; extra == 'dev'
+Requires-Dist: maturin>=1.5 ; extra == 'dev'
+Requires-Dist: pyside6>=6.6 ; extra == 'gui'
+Provides-Extra: all
+Provides-Extra: dev
+Provides-Extra: gui
+License-File: LICENSE
+Summary: Climbing rope physics engine and GUI simulator 
+Keywords: climbing,physics,rope,simulation,UIAA,EN892,safety
+Author-email: Londopy <ropesim@pxdmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/Londopy/ropesim/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://github.com/Londopy/ropesim
+Project-URL: Issues, https://github.com/Londopy/ropesim/issues
+Project-URL: Repository, https://github.com/Londopy/ropesim
+
+# RopeSim
+
+**Climbing rope physics engine and GUI simulator — UIAA 101 / EN 892**
+
+RopeSim models lead-fall dynamics using a damped spring / RK4 integration in
+Rust, exposed to Python via PyO3/Maturin.  It ships a full Python API, a
+five-command CLI, and a PySide6 desktop GUI.
+
+[![CI](https://github.com/Londopy/ropesim/actions/workflows/ci.yml/badge.svg)](https://github.com/Londopy/ropesim/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/ropesim)](https://pypi.org/project/ropesim/)
+[![Python 3.10+](https://img.shields.io/pypi/pyversions/ropesim)](https://pypi.org/project/ropesim/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## Features
+
+- **UIAA 101 / EN 892** impact-force model with belay-device friction, wet-rope modifier, and temperature correction
+- **RK4 force-time curve** — full damped spring integration in Rust for accurate energy modelling
+- **Parallel batch sweeps** via Rayon — sweep 200 fall positions in milliseconds
+- **Anchor system physics** — sliding-X, quad, 2-bolt cordelette with load distribution
+- **25-rope database** covering Beal, Mammut, Sterling, Petzl, Edelrid, Black Diamond, and more
+- **PySide6 GUI** — drag-and-drop route builder, live simulation, fall animation, matplotlib plots, PDF/CSV export
+- **CLI** — five commands: `simulate`, `anchor`, `list-ropes`, `validate-rope`, `sweep`
+
+---
+
+## Installation
+
+### Pre-built wheel (recommended)
+
+```bash
+pip install ropesim            # physics library + CLI only
+pip install "ropesim[gui]"     # + PySide6 GUI
+```
+
+### From source (requires Rust toolchain)
+
+```bash
+git clone https://github.com/Londopy/ropesim.git
+cd ropesim
+pip install maturin
+maturin develop --release      # compiles Rust, installs in editable mode
+pip install ".[gui]"           # optional GUI deps
+```
+
+---
+
+## Quick start — Python API
+
+```python
+from ropesim.rope import RopeDatabase
+from ropesim.fall import FallConditions, Fall, BelayDevice
+
+# Load a rope from the bundled database
+spec = RopeDatabase().get("Mammut Crag Classic 10.2")
+
+# Simulate a factor-0.5 fall on 20 m of rope
+conditions = FallConditions(
+    climber_mass_kg=80.0,
+    fall_distance_m=10.0,   # fell 2 × 5 m above last pro
+    rope_out_m=20.0,
+    belay_device=BelayDevice.GRIGRI,
+    rope=spec,
+)
+result = Fall(conditions).simulate()
+
+print(f"Peak impact force : {result.peak_force_kn:.2f} kN")
+print(f"Fall factor       : {result.fall_factor:.3f}")
+print(f"Energy absorbed   : {result.energy_budget.rope_absorption_j:.0f} J")
+print(f"Warnings          : {result.warnings or 'none'}")
+```
+
+### Scenario builder (multi-pitch / gear placement)
+
+```python
+from ropesim.rope import Rope, RopeDatabase
+from ropesim.anchor import AnchorSystem, AnchorType, Bolt
+from ropesim.simulate import Scenario
+
+rope = Rope(RopeDatabase().get("Beal Opera 8.5 Dry"))
+scenario = Scenario(rope=rope, climber_mass_kg=75.0)
+
+# Place three bolts
+for height in [3.0, 7.0, 12.0]:
+    anchor = AnchorSystem(AnchorType.SINGLE_POINT, [Bolt(rated_mbs_kn=25.0)])
+    scenario.add_protection(height, anchor, label=f"B{int(height)}")
+
+# Simulate a fall from 15 m
+result = scenario.simulate_fall(climber_height_m=15.0)
+print(f"Peak: {result.peak_force_kn:.2f} kN  FF: {result.fall_factor:.3f}")
+
+# Sweep all positions
+sweep = scenario.sweep_fall_positions(steps=60)
+print(f"Worst position: {sweep.worst_height_m:.1f} m → {sweep.worst_peak_kn:.2f} kN")
+```
+
+### Batch parallel sweep (Rust/Rayon)
+
+```python
+from ropesim._rustcore import batch_sweep_fall_factors
+import numpy as np
+
+fall_factors = np.linspace(0.1, 2.0, 200).tolist()
+peak_forces  = batch_sweep_fall_factors(
+    mass_kg=80.0,
+    ff_values=fall_factors,
+    stiffness_kn=20.0,
+    belay_friction=0.35,
+)
+print(f"Max peak: {max(peak_forces):.2f} kN at FF {fall_factors[peak_forces.index(max(peak_forces))]:.2f}")
+```
+
+---
+
+## CLI
+
+```bash
+# List all ropes in the database
+ropesim-cli list-ropes
+
+# Simulate a single fall
+ropesim-cli simulate --mass 80 --fall-distance 8 --rope-out 20 --device grigri
+
+# Anchor force distribution
+ropesim-cli anchor --type sliding_x --load-kn 9.5 --angle 60
+
+# Sweep fall positions
+ropesim-cli sweep --mass 80 --rope "Beal Opera 8.5 Dry" --steps 50
+
+# Validate rope data
+ropesim-cli validate-rope --name "Mammut Crag Classic 10.2"
+```
+
+Add `--json` to any command for machine-readable output.
+
+---
+
+## GUI
+
+```bash
+ropesim          # launch the desktop GUI (requires pip install "ropesim[gui]")
+```
+
+<!-- Screenshot placeholder -->
+<!-- ![RopeSim GUI](docs/screenshot.png) -->
+
+**Workflow:**
+1. Select a rope from the left panel
+2. Double-click the canvas or use the toolbar to place bolts, cams, or nuts
+3. Set climber mass and height
+4. Press **F5** (or ▶ Run) to simulate a fall — watch the animation
+5. Press **F6** to sweep all positions and see the force-vs-height plot
+6. Export results as PDF or CSV from the File menu
+
+**Keyboard shortcuts:**
+
+| Key | Action |
+|-----|--------|
+| `F5` | Run fall simulation |
+| `F6` | Sweep all positions |
+| `F7` | Zipper analysis |
+| `B` / `C` / `N` | Add bolt / cam / nut |
+| `F` | Fit canvas to view |
+| `Ctrl+Scroll` | Zoom canvas |
+| `Middle-drag` | Pan canvas |
+| `Delete` | Remove selected gear |
+
+---
+
+## Physics model
+
+The impact force is computed using the UIAA 101 analytic formula:
+
+```
+F = mg + √((mg)² + 2·mg·ff·k_eff)
+```
+
+where `k_eff` is the length-normalised rope stiffness back-calculated from the
+EN 892 test-mass drop (80 kg, fall factor 1.77).  The full force-time curve is
+obtained by integrating the damped spring equation with a 4th-order
+Runge-Kutta solver at 1 ms resolution.
+
+Modifiers applied:
+- **Belay device friction** (Grigri: 55%, ATC: 35%, Munter: 45% …)
+- **Wet rope** +12 % impact force (EN 892 §6.1.3)
+- **Temperature** — stiffness increases ~2 % per 10 °C below 20 °C
+- **Rope age / degradation** — elongation and stiffness drift modelled from
+  published UIAA fatigue data
+
+---
+
+## Development
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev,gui]"
+
+# Run tests (no Rust required)
+pytest -m "not requires_rust"
+
+# Run full suite (after maturin develop)
+pytest
+
+# Benchmarks
+pytest -m benchmark --benchmark-only
+```
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+