API reference#

Every public class and function of the package, generated from the docstrings. Most programs need only the models of gearbox (importable from the package itself, from gearbox import Gear) and the calculate_* functions of the two standards. The modules whose name starts with an underscore hold the factors of each standard; they are not part of the stable interface, but they are listed here because the theory pages refer to them.

The packages re-export their main names, so the paths of the examples are shorter than the module paths below:

from gearbox import Gear, Material, Tool, Transmission         # gearbox.models, gearbox.transmission
from gearbox.standards import iso6336, agma2101                # iso6336.calculate_pitting, ...
from gearbox.fem import mesh_gear, solve_bending, solve_contact  # gearbox.fem.mesh, gearbox.fem.calculix

Gear and pair models#

`gearbox.models`	Input models: cutting tool, material, lubricant and gear.
`gearbox.transmission`	A pair of meshing gears plus the operating conditions needed for strength calculations.
`gearbox.enums`	Enumerations for the discrete choices that gear standards define as tables or categories.

Geometry#

`gearbox.profile`	Transverse tooth form of an external cylindrical gear generated by a rack (hob).
`gearbox.mathutils`	Small geometry and trigonometry helpers shared across the package.
`gearbox.optimization`	Profile shift (addendum modification) optimisation of a gear pair.

ISO 6336#

`gearbox.standards.iso6336.pitting`	Surface durability (pitting) of cylindrical gears according to ISO 6336-2.
`gearbox.standards.iso6336.bending`	Tooth root strength of cylindrical gears according to ISO 6336-3.
`gearbox.standards.iso6336._load_factors`	Load factors of ISO 6336-1 (method B): dynamic, face and transverse load factors.
`gearbox.standards.iso6336._materials`	Material-group tables shared by the ISO 6336 factor functions.

AGMA 2001-D04 and AGMA 908-B89#

`gearbox.standards.agma2101.pitting`	Surface durability (pitting) of cylindrical gears according to AGMA 2001-D04.
`gearbox.standards.agma2101.bending`	Tooth bending strength of cylindrical gears according to AGMA 2001-D04.
`gearbox.standards.agma2101._geometry`	Geometry factors `I` (pitting) and `J` (bending) of AGMA 908-B89 as used by AGMA 2001-D04.
`gearbox.standards.agma2101._factors`	Influence factors of AGMA 2001-D04 other than the geometry factors.
`gearbox.standards.agma2101._strength`	Allowable stress adjustments of AGMA 2001-D04: `Z_N`, `Y_N`, `C_H`, `K_R` and `K_T`.
`gearbox.standards._hertz`	Hertzian contact quantities shared by the ISO 6336 and AGMA 2101 implementations.

Finite elements#

`gearbox.fem.mesh`	Structured quad/hex meshes of gear teeth and gear pairs, generated with Gmsh.
`gearbox.fem.calculix`	Finite-element analysis of gears with CalculiX.
`gearbox.fem.post`	Post-processing of the FEM analyses: line of action, contact patches, sweeps and plots.