pyGear Files

=================================================
pyGear
=================================================

license:
This code is published under the terms of the GNU General Public License v3
http://www.gnu.org/licenses/gpl-3.0.html

project home:
https://sourceforge.net/projects/pygear/

The code has been tested with Python 2.6, http://www.python.org
required modules (tested with version):
1. pythonOCC (0.4), http://www.pythonocc.org
2. wxPython (2.8), http://www.wxpython.org
3. NumPy (1.4.0-rc1), http://numpy.scipy.org
4. SciPy (0.7.1), http://numpy.scipy.org

What is pyGear?
--------------

PyGear is open-source software for generating gear geometry and calculating
gear properties. It is intendet to be used as a pre-processor for Computer-
Aided Design and Computer-Aided Engineering.
It relies on industry standards in order to create the most
exact shapes possible. At the same time it is easy to use, as it let's you
generate geometries in many different ways, even with a minimum of input
data provided. The gear-geometry can be exported as 2d-coordinates or in
3d as STEP, IGES or VRML-file.

PyGear relies on Python and additionally the modules pythonOCC, wxPython,
NumPy and SciPy are required.


pyGear structure
---------------

Currently pyGear consists of the following files:

  README.txt
  setup.py
  pygear.py
  license.txt


License information
-------------------

See the file "license.txt" for terms & conditions for usage, and a DISCLAIMER
OF ALL WARRANTIES.


ChangeLog
-------------------
0.12:	- gear-generator for cylindrical gear wheels (spur, helical, internal, external)
		- 2d-export (x-y-coordinates)
		- 3d-export (STEP, IGES, VRML) and display
		- basic gear pair calculations
0.14:	- tooth thickness allowance --> exact flank
		- addendum allowance
		- acceptance backlash calculation
		- tip chamfer enhancements
		- bug fixes
		- renamed classes:
			"SpurGearWheel" --> "CylindricalGearWheel"
			"SpurGearPair" --> "CylindricalGearPair"
			

Installation
---------------------
make sure you have Python (http://www.python.org) installed.

make sure that the following packages are installed:
1. pythonOCC, http://www.pythonocc.org
2. wxPython, http://www.wxpython.org
3. NumPy, http://numpy.scipy.org
4. SciPy, http://numpy.scipy.org

then copy the file pygear.py to 
<python path>\Lib\site-packages


Documentation
------------------
sorry, not yet. See the comments in the source code of file pygear.py for some documentation.

			
Example
------------------
On Python Shell type:
>>> from pygear import *
>>> extgear_1 = {'m_n':5.0,'z':20,'beta':30.0,'alpha_n':20.0,'x':0.5,'b':50.0,'z_2':63,'a':245.0,'h_k':0.5,'d_Ff':112.0,'d_s':60.0,'A_s':-0.05}
>>> mygear1 = CylindricalGearWheel(extgear_1)
>>> print mygear1
>>> c  = mygear1.makeOCCSolid()
>>> [m, J, r_g] = mygear1.calcInertiaProperties(7.85e-6)
>>> print 'mass:\t', m
>>> print 'inertia tensor:\n', J[0], '\n', J[1], '\n', J[2]
>>> extgear_2 = {'m_n':5.0,'z':63,'beta':-30.0,'alpha_n':20.0,'b':50.0,'a':245.0,'h_k':0.0,'d_s':130.0}
>>> mygear2 = CylindricalGearWheel(extgear_2)
>>> mypair = CylindricalGearPair({'a':245}, mygear1, mygear2)
>>> print mypair
>>> writeOCCShape(c, 'extgear_1.stp', 'step')
>>> displayOCCShape([c])