A gear generator in python.
Currently the recommended way is to clone or download this repository, install dependencies from requirements.txt and then install gggears.
pip install -r requirements.txt
pip install .
There is an ongoing version-mismatch issue with build123d, ocp-vscode and ocp-cadquery packages. Obtaining dependencies via pip might cause problems. If using OCP VSCode for the first time, quickstart with build123d might cause problems because it grabs the newest version from build123d github. If build123d is already installed, use the 'package manager' window instead.
For compatibility with dev version of build123d, use gggears branch CAD_refactor_and_bd_090_compliance.
Follow this issue for details.
Gggears CAD model creation uses build123d package: build-123d github
gggears main depends on build123d 0.8.0, while gggears branch CAD_refactor_and_bd_090_compliance is compatible with build123d dev branch (planned v0.9.0).
It is highly recommended, though not strictly necessary to use a python-CAD gui solution. See OCP VSCode and CadQuery Editor.
Docs hosted on readthedocs
Gear generation:
- Spur gears
- Helical / spiral gears
- Bevel gears
- Inside-ring gears
- Profile shift
- Undercut
- Root / tip fillets
- Cycloid gears
Gear positioning and alignment supported.
Not yet supported:
- Hypoid gears
- Worm gears
- Face / crown gears
- Racks
Planned upcoming other features
- Planetary drive design
- Design calculations and parameter optimization
The example is built on VSCode with OCP VScode plugin.
See examples.py for more.
from gggears import *
from ocp_vscode import show, set_port
set_port(3939)
# create 2 spur gears
gear1 = SpurGear(number_of_teeth=12)
gear2 = SpurGear(number_of_teeth=24)
# move and align gear 1 next to gear 2 in the Y direction
gear1.mesh_to(gear2, target_dir=UP)
# generate build123d Part objects
gear_part_1 = gear1.build_part()
gear_part_2 = gear2.build_part()
# visualize parts
show(gear_part_1, gear_part_2)
A simple PyQT6 based graphical interface can be used by running gggui.py.
python .\gui\gggui.py
This GUI uses OCP vscode for visualization.
Project is licensed under Apache 2.0, see license file for details.