#!/usr/bin/env python
# coding: utf-8

# [<img align="left" width="140px" src="https://storage.googleapis.com/static.drivetrainhub.com/img/dh_logo_text_217x80.png"/>](https://drivetrainhub.com)
# 
# <div align="right">© 2020 Drivetrain Hub LLC</div>

# # Geometry / Spur Gears
# ---
# 
# **Authors**:  [Tugan Eritenel](https://github.com/tugan1) 
# 
# **Description**:  Geometry of spur gears, given constraints on ratio, center distance, and clearances.

# ## Table of Contents
# 
# 1. [Introduction](#Introduction)
# 1. [Definitions](#Definitions)
#     1. [Profile Shift](#Profile-Shift)
#     1. [Undercut](#Undercut)
#     1. [Addendum Modification](#Addendum-Modification)
# 1. [Design Process](#Design-Process)
#     1. [Choosing Number of Teeth](#Choosing-Number-of-Teeth)
#     1. [Calculate Profile Shift](#Calculate-Profile-Shift)
#     1. [Calculate Addendum Modification](#Calculate-Addendum-Modification)
#     1. [Checks](#Checks)
# 1. [References](#References)

# # Introduction
# 
# This chapter is on designing the geometry of spur gear pairs.  Here, the module and the center distance is specified. The gear pair is designed to achieve a desired gear ratio, while the gear geometry is within limits of certain criteria.
# 
# <img src="./img/drivetrainhub_spur_gearset_17-30.png" alt="SPUR GEAR PAIR" style="max-width: 100%; max-height: 350px"/>
# <p style="text-align: center; font-weight: bold;">Spur gear pair modeled in <a href="https://drivetrainhub.com/gears" style="text-decoration: none;">Gears App</a></p>

# Notebook imports and settings

# In[1]:


import ipywidgets as widgets
from IPython import display
from IPython.core.display import HTML
import pandas as pd
from pprint import pprint
import math


# Involute function, pressure angle, and tooth thickness functions.

# In[2]:


def inv(a):
    return math.tan(a) - a

def alpha_at_given_d(d,d_b):
    return math.acos(d_b/d)

def thickness_at_given_d(d,d_p,d_b,alpha,m,x):
    S_p = math.pi/2*m + 2*m*x*math.tan(alpha)
    alpha_d = alpha_at_given_d(d,d_b)
    S = d*(S_p/d_p+inv(alpha)-inv(alpha_d))
    return S


# # Definitions
# The table below shows the definitions of basic gear geometry paramaters, and equations needed to calculate them.
# 
# <table>
#     <thead>
#         <td>Parameter</td><td style="width:200px">Expression</td><td>Units</td>
#     </thead>
#     <tr>
#         <td>Involute function</td><td>$\rm{inv}\left({\theta}\right) = \tan\theta - \theta $</td><td>rad</td>
#     </tr>
#     <tr>
#         <td>Number of gear teeth</td><td>$z$</td><td>None</td>
#     </tr>
#     <tr>
#         <td>Normal module</td><td>$m$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Generating pressure angle</td><td>$\alpha$</td><td>deg</td>
#     </tr>
#     <tr>
#         <td>Profile shift</td><td>$x$</td><td>$m$</td>
#     </tr>
#     <tr>
#         <td>Addendum modification</td><td>$y$</td><td>$m$</td>
#     </tr>
#     <tr>
#         <td>Pitch diameter</td><td>$d_p = mz$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Base diameter</td><td>$d_b = d_p \cos \alpha$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Tip diameter</td><td>$d_t= d_p + 2m\left(1+x-y\right)$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Root diameter</td><td>$d_r= d_p + 2m\left(-1.25+x\right)$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Base pitch</td><td>$B_p= m\pi\cos\alpha$</td><td>mm</td>
#     </tr>
# </table>
# 
# In a gear pair, parameters that belong to the first gear are indicated with subscript 1, and parameters that belong to the second gear are indicated with subscript 2.  The gear with the lower number of teeth is referred to as the "pinion", and the gear with the higher number of teeth is referred to as the "wheel". The term "working" refers to the parameters when the gear pair is operating at a given center distance.
# 
# <table>
#     <thead>
#         <td>Parameter</td><td style="width:200px">Expression</td><td>Units</td>
#     </thead>
#     <tr>
#         <td>Standard center distance</td><td>$a_0 = m\frac{z_1 + z_2}{2}$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Operating center distance</td><td>$a$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Working pressure angle</td><td>$\alpha_w = \cos^{-1}\left( \frac{a_0}{a} \cos\alpha \right) $</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Working pitch diameter</td><td>$d_w = \frac{d_b}{\cos\alpha_w}$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Contact ratio</td><td> $R = \frac{\frac{\sqrt{d^2_{t,1} -d^2_{r,1}} + \sqrt{d^2_{t,2} -d^2_{r,2}}}{4} -a\sin\alpha_w} {B_p}$ </td><td>None</td>
#     </tr>
#     
# </table>
# 
# Parameters and expressions on tooth thickness, backlash, and tip-to-root clearances are given in table below.
# <table>
#     <thead>
#         <td>Parameter</td><td style="width:250px">Expression</td><td>Units</td>
#     </thead>
#     <tr>
#         <td>Circular tooth thickness at pitch diameter</td><td> $S_p = \frac{m}{2}\pi + 2mx\tan\alpha$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Pressure angle at a given diameter, $d$</td><td> $\alpha(d) = \cos^{-1}\left(\frac{d_b}{d} \right)$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Circular tooth thickness at a given diameter, $d$</td><td> $S(d) = d\left( \frac{S_p}{d_p} + \rm{inv}\alpha - \rm{inv}\alpha_d \right)$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Circular backlash</td><td> $B_c = \frac{B_p}{\cos\alpha_w} - S\left(d_{w,1}\right) -  S\left(d_{w,2}\right)$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Linear backlash</td><td> $B_l = B_c \cos\alpha_w$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Pinion tip to gear root clearance</td><td> $c_1 =a - a_0 - m\left(x_1+x_2 - y_1 \right)$</td><td>mm</td>
#     </tr>
#     <tr>
#         <td>Gear tip to pinion root clearance</td><td> $c_2 =a - a_0 - m\left(x_1+x_2 - y_2 \right)$</td><td>mm</td>
#     </tr>
# </table>

# ## Profile Shift
# Hob can be pushed or pulled while gears are manufactured.  This affects the shape of the gear tooth generated.  A positive profile shift indicates that the hob is pulled away from the gear center.
# 
# ### Advantages of Positive Profile Shift
# <ul>
#     <li>Reduces or eliminates undercut</li>
#     <li>Reduces root stress by increasing tooth thickness</li>
#     <li>Improves radius of curvature at contact</li>
# </ul>
# 
# ### Disadvantages of Positive Profile Shift
# <ul>
#     <li>Reduces tooth tip thickness, can lead to peaking</li>
#     <li>Can reduce contact ratio</li>
# </ul>
# 
# <br>
# <img src="./img/drivetrainhub_spur_compare-profile-shifts.png" alt="GEAR MESH PROFILE SHIFTS" style="max-height: 300px; max-width: 100%; text-align: center;"/>
# <p style="text-align: center; font-weight: bold;">Negative (left) and positive (right) profile shifts in <a href="https://drivetrainhub.com/gears" style="text-decoration: none;">Gears App</a></p>

# ## Undercut
# Involute profile is not defined below the base circe.  Undercut occurs when tool tip corner does not cut the transition point between the root fillet and the involute profile.  Undercut which increases stress concentration.  Undercut is generally to be avoided or reduced if possible.  Gears with low number of teeth are more prone to undercut.  
# 
# The minimum number of gear teeth without undercut is given by,
# 
# $$ z_{min} = \frac{2}{\sin^2\alpha}$$
# 
# where $\alpha$ is the pressure angle of the hob.  Given the number of teeth, the minimum profile shift required to avoid undercut is given by,
# 
# $$x=\frac{z_{min} - z}{z_{min}}$$
# 
# <br>
# <img src="./img/gears-app_spur_undercut_11z.png" alt="SPUR GEAR UNDERCUT" style="max-height: 250px; max-width: 100%;"/>
# <p style="text-align: center; font-weight: bold;">Spur gear undercut in <a href="https://drivetrainhub.com/gears" style="text-decoration: none;">Gears App</a></p>

# ## Addendum Modification
# To avoid peaking and/or tip-to-root interference, tooth addendum is reduced. No actual tooth are cut off after the gears have been made, but the blank diameter itself is reduced before manufacturing. 
# 
# ### Peaking
# Peaking occurs when the gear tooth tip thickness reaches zero due to positive profile shift.  Generally it is recommended that the tip thickness is greater than $0.25 m$, where $m$ is the normal module.
# 
# ### Tip-to-Root Interference
# Tip-to-root interference occurs when the gear teeth are too long and interfere with the root of the mating gear due to positive profile shift.  Generally, it is recommended that tip-to-root clearance is equal to or greater than $0.25m$.  
# 
# <br>
# <img src="./img/gears-app_spur_near-peaking.png" alt="SPUR GEAR THIN TOOTH TIP" style="max-height: 250px; max-width: 100%;"/>
# <p style="text-align: center; font-weight: bold;">Near peaking spur gear in <a href="https://drivetrainhub.com/gears" style="text-decoration: none;">Gears App</a></p>

# # Design Process
# 
# The geometric design process is explained by means of an example.  Requirements are as follows:

# In[3]:


I = pd.Index(["Module","Working center distance","Standard pressure angle","Ratio","Ratio tolerance","Backlash","Tip-To-Root Clearance"],name="rows")
C = pd.Index(["Common","Units"],name="columns")
df_requirements = pd.DataFrame(data=None,index=I,columns=C)
df_requirements["Common"]["Module"]=2.5
df_requirements["Units"]["Module"]="mm"
df_requirements["Common"]["Working center distance"]=122
df_requirements["Units"]["Working center distance"]="mm"
df_requirements["Common"]["Standard pressure angle"]=20
df_requirements["Units"]["Standard pressure angle"]="deg"
df_requirements["Common"]["Ratio"]=1.063829787
df_requirements["Units"]["Ratio"]=""
df_requirements["Common"]["Ratio tolerance"]=0.0001
df_requirements["Units"]["Ratio tolerance"]=""
df_requirements["Common"]["Backlash"]=0.1
df_requirements["Units"]["Backlash"]="mm"
df_requirements["Common"]["Tip-To-Root Clearance"]=0.25
df_requirements["Units"]["Tip-To-Root Clearance"]="module"

widget= widgets.Output()
with widget:
    display.display(df_requirements)
hbox = widgets.HBox([widget])
hbox


# In[4]:


alpha=df_requirements["Common"]["Standard pressure angle"]/180*math.pi
i_required = df_requirements["Common"]["Ratio"]
i_tol = df_requirements["Common"]["Ratio tolerance"]
m = df_requirements["Common"]["Module"]
a = df_requirements["Common"]["Working center distance"]
B_req = df_requirements["Common"]["Backlash"]


# ## Choosing Number of Teeth
# 
# In this notebook, the aim of design is to minimize the size of the gears. To that end, the lowest number of teeth possible within limits should be chosen.  For a first design iteration, the minimum acceptable number of teeth is chosen to avoid undercut without profile shift, given by $z_{min} = \frac{2}{\sin^2\alpha}$.  The number of teeth can be reduced by one or two in the following design iterations, if profile shift eliminates undercut.
# 
# The selected number of teeth should also satisfy the required gear ratio within a given tolerance.  Since gear ratio is defined by $i=\frac{z_2}{z_1}$, rearranging gives $z_2=i z_1$.  Number of teeth on the wheel is found using the minimum number of teeth for the pinion.  If the actual gear ratio is not within tolerance, the number of teeth on the pinion is incremented, and the process is repeated until the actual gear ratio is within tolerance.  The following code automates this process.  

# In[5]:


z_1 = 2/(math.sin(alpha)**2)
z_1 = int(round(z_1))
z_2 = int(round(z_1*i_required))
print(z_2)
i = z_2/z_1
iteration_count=0
max_iter = 400
while abs(i - i_required)>i_tol:
    z_1=z_1+1
    z_2 = int(round(z_1*i_required))
    i = z_2/z_1
    iteration_count=iteration_count+1
    if iteration_count>max_iter:
        print("ERROR: Iteration count of " +str(200) + " exceeded, increase ratio tolerance.")
        break

display.display(HTML('<div class="alert alert-block alert-info">Pinion number of teeth, $z_1$ = ' + str(z_1) + '</div>'))
display.display(HTML('<div class="alert alert-block alert-info">Wheel number of teeth, $z_2$ = ' + str(z_2) + '</div>'))
display.display(HTML('<div class="alert alert-block alert-info">Actual gear ratio, $i$ = ' + str(round(i,3)) + '</div>'))
display.display(HTML('<div class="alert alert-block alert-info">Required gear ratio, $i_{\\rm{required}}$ = ' + str(round(i_required,3)) + '</div>'))


# ## Calculate Profile Shift
# 
# Once the number of teeth is known, the standard center distance is calculated by $a = m\frac{z_1+z_2}{2}$
# 
# Since the operating center distance is specified as a requirement, the working pressure angle is found using $\alpha_w = \cos^{-1}\left(\frac{a_0}{a\cos\alpha}\right)$

# In[6]:


a_0 = m*(z_1+z_2)/2
alpha_w = math.acos(a_0/a*math.cos(alpha))
display.display(HTML('<div class="alert alert-block alert-info">Standard center distance, $a_0$ = ' + str(a_0) + '</div>'))
display.display(HTML('<div class="alert alert-block alert-info"> Working pressure angle, $\\alpha_w$ =' + str(round(alpha_w*180/math.pi,3)) + ' deg </div>'))


# Usually, the standard center distance does not equal the required center distance, which may be dictated by other design restrictions such as packaging or manufacturing.  Generally the gear tooth numbers are chosen such that the operating center distance is greater than the standard center distance; this is called *extended center distance*. 
# 
# If the gears operate at extended center distance without profile shift, undesirable large backash will result and the contact ratio may be too low. For these reasons, profile shift is applied such that the only source of backlash is the thinning of the hob.  Whether or not the centers are extended, any undercut on the pinion may be removed by moving the profile shift to the gear.
# 
# The total profile shift needed is found by,
# 
# $$x_1 + x_2 = \frac{\left(z_1+z_2\right) \left(\rm{inv}\alpha_w -\rm{inv}\alpha\right)}{2\tan\alpha}$$

# In[7]:


x_total = (z_1 + z_2)*(inv(alpha_w) - inv(alpha))/2/math.tan(alpha) 


# The equation above results in gears with zero backlash excluding what is built into the hob.  If a specified curcular backlash is required, the total profile shift can be updated by, 
# 
# $$x_{mod} = -\frac{B_{c,req}}{2 m \tan\alpha} \frac{\cos\alpha_w}{\cos\alpha}$$
# 
# which modifies the total profile shift by,
# 
# $$ \left(x_1 + x_2 \right)_{\rm{new}}= x_1+x_2 + x_{mod}$$

# In[8]:


x_mod = -B_req/(2*m*math.tan(alpha))*math.cos(alpha_w)/math.cos(alpha)
display.display(HTML('<div class="alert alert-block alert-info"> Reduction in profile shift to obtain the required backlash, $x_{mod}$ = ' + str(round(x_mod,3)) + '</div>'))


# ### Distributing Profile Shift
# 
# The sum of profile shift needed for the gears to operate at the required center distance can be distributed in any way between the pinion and the gear.  However, a few empirical equations help improve the design.
# 
# For reduced sliding velocity, 
# $$x_1 \approx \frac{x_1+x_2}{i+1}+\frac{i-1}{i+1+0.4 z_2}$$
# 
# For equal root stress,
# $$x_1 \approx \frac{x_1+x_2}{i+1}+\frac{1}{2}\left(\frac{i-1}{i+1}\right)$$
# 
# For equal contact pressure,
# $$x_1 \approx \frac{x_1+x_2}{i+1}\frac{z_1+12}{z_1+2} + \frac{8}{z_1+2}$$
# 
# Using the formula for equal root stress, 

# In[9]:


x_total = x_total + x_mod
display.display(HTML('<div class="alert alert-block alert-info"> Total profile shift, $x_1 + x_2$ = ' + str(round(x_total,3)) + '</div>'))
x_1 = x_total / (i + 1) + 0.5 * (i - 1) / (i + 1)
x_2 = x_total - x_1

display.display(HTML('<div class="alert alert-block alert-info"> Pinion profile shift, $x_1$ = ' + str(round(x_1,3)) + '</div>'))
display.display(HTML('<div class="alert alert-block alert-info"> Wheel profile shift, $x_2$ = ' + str(round(x_2,3)) + '</div>'))


# ## Calculate Addendum Modification
# The tip-to-root clearance is found using the equation, for the pinion and gear respectively,
# 
# $$c_1 =a - a_0 - m\left(x_1+x_2 - y_1 \right)$$
# $$c_2 =a - a_0 - m\left(x_1+x_2 - y_2\right)$$
# 
# Find required addendum modification, if needed, so that <b>tip-to-root clearance</b> is at least $0.25m$, using,

# In[10]:


c_req = 0.25
y = c_req + x_total - (a - a_0) / m
y_1 = y
y_2 = y

if y > 0:
    display.display(HTML('<div class="alert alert-block alert-info">Addendum modification, y = ' + str(round(y,3)) + ' is applied<br>This is a reduction in addendum</div>'))
elif y <= 0:
    display.display(HTML('<div class="alert alert-block alert-info">Addendum modification, y = ' + str(round(y,3)) + ' is applied<br>This is an increase in addendum</div>'))    


# ## Checks
# This section lists parameters that needs to be checked to make sure the outputs of the design are within limits.  If a parameter does not satisfy the requirements, then the design needs to be updated.    

# ### CHECK: Undercut in pinion and wheel
# After profile shift is applied, check for undercut pinion and wheel.  Undercut occurs if,
# 
# $$x_1 < \frac{z_{min}-z_1}{z_{min}} \quad \text{where } z_{min} = \frac{2}{\sin^2\alpha}$$

# In[11]:


z_min = 2 / math.sin(alpha) ** 2 
x_1_min = (z_min - z_1) / z_min
x_2_min = (z_min - z_2) / z_min

if x_1 < x_1_min:
    display.display(HTML('<div class="alert alert-block alert-danger">Pinion is undercut</div>'))
else:
    display.display(HTML('<div class="alert alert-block alert-info">Pinion is safe for undercut</div>'))
    
if x_2 < x_2_min:
    display.display(HTML('<div class="alert alert-block alert-danger">Wheel is undercut</div>'))
else:
    display.display(HTML('<div class="alert alert-block alert-info">Wheel is safe for undercut</div>'))


# ### CHECK: Top Land (Tooth Tip Thickness)
# The equation for pinion tooth tip thickness is given by,
# 
# $$ S_{t,1} = d_{t,1}\left( \frac{S_p}{d_p} + \rm{inv}\alpha - \rm{inv}\alpha_{t,1} \right) $$
# 
# where, tooth thickness at pitch circle is given by,
# 
# $$S_p = \frac{m}{2}\pi + 2mx\tan\alpha$$
# 
# where, pressure angle at tooth tip is given by,
# 
# $$\alpha_{t,1} = \cos^{-1}\left(\frac{d_b}{d_{t,1}} \right)$$
# 
# The equations for gear tooth tip thickness are identical with appropriate subscripts representing parameters for the gear.
# 
# Check that pinion and wheel tooth tip thickness is at least $0.25m$.  

# In[12]:


d_p1 = z_1 * m
d_b1 = d_p1 * math.cos(alpha)
d_t1 = d_p1 + 2 * m * (1 + x_1 - y_1)
S_t1 = thickness_at_given_d(d_t1, d_p1, d_b1, alpha, m,x_1)

if S_t1 / m < 0.25:
    display.display(HTML('<div class="alert alert-block alert-danger">Pinion tip thickness is too small, reduce profile shift or increase addendum modification.</div>'))
else:
    display.display(HTML('<div class="alert alert-block alert-info">Pinion tip thickness is good, $S_{t,1}$ = ' + str(round(S_t1/m,3)) + 'm</div>'))
    
d_p2 = z_2 * m
d_b2 = d_p2 * math.cos(alpha)
d_t2 = d_p2 + 2 * m * (1 + x_2 - y_2)
S_t2 = thickness_at_given_d(d_t2, d_p2, d_b2, alpha, m, x_2)

if S_t2 / m < 0.25:
    display.display(HTML('<div class="alert alert-block alert-danger">Wheel tip thickness is too small, reduce profile shift or increase addendum modification.</div>'))
else:
    display.display(HTML('<div class="alert alert-block alert-info">Wheel tip thickness is good, $S_{t,2}$ = ' + str(round(S_t2/m,3)) + 'm</div>'))


# ### CHECK: Backlash
# Backlash required can be found in IS:4460.  For low speed gears where pitch line velocity is below 8 m/s, maximum backlash for $m=2$ mm is 0.13 mm, for $m=8$ mm, is 0.4mm. For higher speed gears where pitch line velocity is above 8 m/s, maximum backlash for $m=2$ mm is 0.18 mm, for $m=8$ mm, is unchanged at 0.4mm.<br>
# 
# Check backlash below.  Note that the backlash calculated here should match the specified backlash $B_{req}$.  

# In[13]:


BP = m * math.pi * math.cos(alpha)
d_w1 = d_b1 / math.cos(alpha_w)
d_w2 = d_b2 / math.cos(alpha_w)
B_c = BP / math.cos(alpha_w) - thickness_at_given_d(d_w1, d_p1, d_b1, alpha, m, x_1) - thickness_at_given_d(d_w2, d_p2, d_b2, alpha, m, x_2)

display.display(HTML('<div class="alert alert-block alert-info">Backlash, $B_c$ = ' + str(round(B_c,3)) +' mm </div>'))


# ### CHECK: Contact Ratio
# Contact ratio should be above 1.1 to ensure contact is maintained at all times. 
# Contact ratio is found from tip and root diameters as given by the equation
# 
# $$R = \frac{\frac{\sqrt{d^2_{t,1} -d^2_{r,1}} + \sqrt{d^2_{t,2} -d^2_{r,2}}}{4} -a\sin\alpha_w} {B_p}$$
# 

# In[14]:


d_r1 = d_p1 + 2 * m * (-1.25 + x_1)
d_r2 = d_p2 + 2 * m * (-1.25 + x_2)
CR = (math.sqrt( d_t1 ** 2 / 4 - d_b1 ** 2 / 4 ) + math.sqrt( d_t2 ** 2 / 4 - d_b2 ** 2 / 4 ) - a * math.sin(alpha_w) ) / (BP)

if CR < 1.1:
    display.display(HTML('<div class="alert alert-block alert-danger">Contact ratio is too small, CR = ' + str(round(CR,3)) +' <br>Update design requirements</div>'))
else:
    display.display(HTML('<div class="alert alert-block alert-info">Contact ratio is good, CR = ' + str(round(CR,3)) +'</div>'))


# ### CHECK: Tip-to-Root Clearance
# Calculate tip-to-root clearance.  Note that this should match the required clearance, since addendum modification is calculated to maintain $0.25m$ clearance.

# In[15]:


c_1 = a - a_0 - m * (x_1 + x_2 - y_1 )
c_2 = a - a_0 - m * (x_1 + x_2 - y_2 )

display.display(HTML('<div class="alert alert-block alert-info">Clearance, $c_1/m$ = ' + str(c_1/m) +'</div>'))
display.display(HTML('<div class="alert alert-block alert-info">Clearance, $c_2/m$ = ' + str(c_2/m) +'</div>'))


# The following table summarizes the gear geometry as designed.<br>

# In[16]:


I_rows = pd.Index(["Number of teeth", "Module","Standard center distance","Working center distance",
                   "Standard pressure angle","Working pressure angle","Backlash","Backlash / module","Contact ratio",
                   "Profile shift","Addendum modification",
                   "Pitch diameter","Tip diameter","Root diameter","Base diameter",
                   "Tooth tip thickness","Tooth tip thickness / module", "Tip root clearance","Tip root clearance / module"
                  ], name="rows")
I_columns = pd.Index(["Pinion","Common","Gear","Units"],name="columns")
df = pd.DataFrame(data=None,index=I_rows,columns=I_columns)

col_name = "Number of teeth"
df["Pinion"][col_name] = z_1
df["Gear"][col_name] = z_2
df["Common"][col_name] = ""
df["Units"][col_name] = ""

col_name = "Module"
df["Pinion"][col_name] = ""
df["Gear"][col_name] = ""
df["Common"][col_name] = m
df["Units"][col_name] = "mm"

col_name = "Standard pressure angle"
df["Pinion"][col_name] = ""
df["Gear"][col_name] = ""
df["Common"][col_name] = alpha*180/math.pi
df["Units"][col_name] = "deg"

col_name = "Working pressure angle"
df["Pinion"][col_name] = ""
df["Gear"][col_name] = ""
df["Common"][col_name] = alpha_w*180/math.pi
df["Units"][col_name] = "deg"

col_name = "Standard center distance"
df["Pinion"][col_name] = ""
df["Gear"][col_name] = ""
df["Common"][col_name] = a_0
df["Units"][col_name] = "mm"

col_name = "Working center distance"
df["Pinion"][col_name] = ""
df["Gear"][col_name] = ""
df["Common"][col_name] = a
df["Units"][col_name] = "mm"

col_name = "Pitch diameter"
df["Pinion"][col_name] = d_p1
df["Gear"][col_name] = d_p2
df["Common"][col_name] = ""
df["Units"][col_name] = "mm"

col_name = "Root diameter"
df["Pinion"][col_name] = d_r1
df["Gear"][col_name] = d_r2
df["Common"][col_name] = ""
df["Units"][col_name] = "mm"

col_name = "Base diameter"
df["Pinion"][col_name] = d_b1
df["Gear"][col_name] = d_b2
df["Common"][col_name] = ""
df["Units"][col_name] = "mm"

col_name = "Tip diameter"
df["Pinion"][col_name] = d_t1
df["Gear"][col_name] = d_t2
df["Common"][col_name] = ""
df["Units"][col_name] = "mm"

col_name = "Profile shift"
df["Pinion"][col_name] = x_1
df["Gear"][col_name] = x_2
df["Common"][col_name] = ""
df["Units"][col_name] = "module"

col_name = "Addendum modification"
df["Pinion"][col_name] = y_1
df["Gear"][col_name] = y_2
df["Common"][col_name] = ""
df["Units"][col_name] = "module"

col_name = "Tooth tip thickness"
df["Pinion"][col_name] = S_t1
df["Gear"][col_name] = S_t2
df["Common"][col_name] = ""
df["Units"][col_name] = "mm"

col_name = "Tooth tip thickness / module"
df["Pinion"][col_name] = S_t1/m
df["Gear"][col_name] = S_t2/m
df["Common"][col_name] = ""
df["Units"][col_name] = "mm"


col_name = "Tip root clearance"
df["Pinion"][col_name] = c_1
df["Gear"][col_name] = c_2
df["Common"][col_name] = ""
df["Units"][col_name] = "mm"

col_name = "Tip root clearance / module"
df["Pinion"][col_name] = c_1/m
df["Gear"][col_name] = c_2/m
df["Common"][col_name] = ""
df["Units"][col_name] = "module"

col_name = "Backlash"
df["Pinion"][col_name] = ""
df["Gear"][col_name] = ""
df["Common"][col_name] = B_c
df["Units"][col_name] = "mm"

col_name = "Backlash / module"
df["Pinion"][col_name] = ""
df["Gear"][col_name] = ""
df["Common"][col_name] = B_c/m
df["Units"][col_name] = "module"

col_name = "Contact ratio"
df["Pinion"][col_name] = ""
df["Gear"][col_name] = ""
df["Common"][col_name] = CR
df["Units"][col_name] = ""

widget1 = widgets.Output()
with widget1:
    display.display(df)
hbox = widgets.HBox([widget1])
hbox


# # Conclusion
# This notebook documents the procedure to find spur gear geometry based on design requirements.  Inputs to the design are required gear ratio, center distance, standard pressure angle, backlash, and tip-to-root clearance.  The outputs are tip, base, root diameters, contact ratio, profile shift, addendum modification, and tooth thickness.  

# ---
# <div class="alert alert-block alert-info" style="box-shadow: 2px 2px 4px 0px rgba(0, 0, 0, .13);">
#     <h3>Model Gears</h3><br>
#     <a href="https://drivetrainhub.com/gears" style="font-weight: bold">Gears App</a> software is used to accurately model, analyze, and build spur gear systems entirely in your <u>web browser</u>.
# </div>

# <div class="alert alert-block alert-info" style="box-shadow: 2px 2px 4px 0px rgba(0, 0, 0, .13);">
#     <h3>Learn More</h3><br>
#     <a href="https://drivetrainhub.com/notebooks/" style="font-weight: bold">Notebook Series</a> is free to learn and contribute knowledge about gears, such as geometry, manufacturing, strength, and more.
# </div>

# <div class="alert alert-block alert-info" style="box-shadow: 2px 2px 4px 0px rgba(0, 0, 0, .13);">
#     <h3>Edit Notebook</h3><br>
#     <a href="https://github.com/drivetrainhub/notebooks/" style="font-weight: bold">GitHub repos</a> are used to publicly host our notebooks, allowing anyone to view and propose edits.
# </div>

# ## References
# 
# 1. G. M. Maitra, (1994), "Handbook of Gear Design", Tata McGraw-Hill
# 2. M. Rameshkumar, G. Venkatesan and P. Sivakumar, (2010), "Finite Element Analysis of High Contact Ratio Gear", AGMA Technical Paper, 10FTM06