Quick Start¶
-
Download & Install
Latest Release: v0.5.1
- 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.5.1
Self-contained desktop experience with bundled backend:
- No Python installation required for GUI
- Bundled CLI—42 MB frozen executable
- Windows testing complete (macOS/Linux in v0.5.2)
- Improved release packaging workflow
Also includes v0.5.0 streaming enhancements.
-
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
Support for XYZ and XAB coordinate systems with flexible 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