A gear workbench for FreeCAD: create involute, cycloid, bevel, worm, timing, lantern and crown gears with full control over parameters.
- FreeCAD ≥ 1.0 (or ≥ 0.16 for older setups); CI tests against 1.1.3 (see CI)
- Python ≥ 3.8 (used by FreeCAD); CI uses 3.12.13
- Python packages:
numpy,scipy,sympy(optional:jupyter,matplotlib)
- Shifting, helical, double helical, undercut, fillets
- Helical, double helical, fillets
- Spiral
In FreeCAD: Tools → Addon Manager → search for “Gears” (or “FCGear”) → Install.
pip install freecad.gearsOr from source:
pip install https://github.com/looooo/freecad.gears/archive/master.tar.gzUse the same Python/pip that FreeCAD uses on your system.
- Open FreeCAD and switch to the Gear workbench.
- File → New (or open a document).
- Create a gear from the toolbar and adjust parameters in the property panel.
import FreeCAD as App
import freecad.gears.commands
gear = freecad.gears.commands.CreateInvoluteGear.create()
gear.num_teeth = 20
gear.beta = 20
gear.height = 10
gear.double_helix = True
App.ActiveDocument.recompute()
Gui.SendMsgToActiveView("ViewFit")The project uses pixi for environment and task management.
pixi install| Command | Description |
|---|---|
pixi run lint |
Run pylint. |
pixi run test |
Unit tests. |
pixi run test-visual |
Visual tests (requires display). |
pixi run test-visual-xvfb |
Visual tests under xvfb. |
pixi run test-all |
All tests. |
pixi run create-references |
Generate reference images. |
pixi run create-references-xvfb |
Generate reference images under xvfb. |
pixi run clean-test |
Remove test artifacts and references. |
Visual tests use freecad.visual_tests: each project under tests/data/*/ has a metafile.yaml and a .FCStd model; references are stored in references/.
Workflow: .github/workflows/ci.yml (push, pull request, manual dispatch).
| FreeCAD | 1.1.3 (pixi.lock, conda-forge) |
| Python | 3.12.13 (pixi.lock) |
| Unit tests | Linux, macOS, Windows |
| Visual tests | Linux only (xvfb) |
| Pylint | Ubuntu; advisory only (does not fail the workflow) |
Manual workflow Update reference images regenerates reference images on CI and pushes them to the repo.
- Elements of Metric Gear Technology (PDF)
- Involute gear generator preview
- Bevel gear – module/script/tutorial
- Gears in FreeCAD: FC Gear
- FC Gears: Feedback thread
Please check the issue tracker before opening a new report.
GNU General Public License v3.0