Quick Start¶
-
Download & Install
Latest Release: v0.7.2
- Desktop GUI – Windows, macOS, Linux installers (no Python required)
- Python Package –
pip install fiberpath - Source – Clone and build from GitHub
-
What's New in v0.7.2
Code-quality, hardening, and dependency-refresh pass:
- API plan/simulate errors now return clear 4xx responses instead of 500s, and streaming diagnostics moved to the
loggingmodule - Hardened Marlin streaming guards (
StreamErrorinstead ofassert) and fixed temporary-file cleanup in the desktop backend - Removed dead code (unused geometry module, redundant planner branches) and aligned docs with the cylindrical planning scope
- Security & dependency refresh: starlette BadHost CVE, js-yaml/undici/rand advisories, and Tauri 2.11
Builds on the v0.7 baseline with reliability and maintainability fixes.
- API plan/simulate errors now return clear 4xx responses instead of 500s, and streaming diagnostics moved to the
-
User Guides
Learn how to work with FiberPath's core features:
- Wind Format – File schema & validation
- Axis Mapping – Coordinate systems
- Marlin Streaming – Hardware control
- Visualization – Preview & plotting
-
API Reference
Technical documentation and specifications:
- Concepts – Terminology glossary
- API Reference – REST endpoints
- Planner Math – Algorithms & formulas
-
Architecture
Understand the system design and internals:
- System Overview – Stack & data flow
- Axis System – Logical vs physical
-
Development
Contribute to FiberPath development:
- Contributing – Guidelines & setup
- Tooling – Dev environment
- CI/CD – Build workflows
Features¶
-
Wind File Format
Define winding patterns with a simple, validated YAML schema
-
Multi-Axis Control
Native XAB rotational-axis output with clear logical axis mapping
-
Marlin Streaming
Direct hardware control with real-time progress and state management
-
Visualization
Preview and plot toolpaths before manufacturing
-
Modular Architecture
CLI, API, and GUI components work standalone or together
-
Layer Strategies
Configurable winding algorithms with mathematical precision