Altered order of __all__ for documentation

fluids/core.py

@@ -19,12 +19,13 @@
 from math import sin, exp, pi
 from scipy.constants import g, R
 
-__all__ = ['thermal_diffusivity', 'c_ideal_gas', 'Reynolds', 'Peclet_heat',
-'Peclet_mass', 'Fourier_heat', 'Fourier_mass', 'Graetz_heat', 'Schmidt',
-'Lewis', 'Weber', 'Mach', 'Knudsen', 'Prandtl', 'Grashof', 'Bond',
-'Rayleigh', 'Froude', 'Strouhal', 'Nusselt', 'Sherwood', 'Biot', 'Stanton',
-'Euler', 'Cavitation', 'Eckert', 'Jakob', 'Power_number', 'Drag', 'Capillary',
-'Archimedes', 'Ohnesorge', 'relative_roughness', 'nu_mu_converter', 'gravity',
+__all__ = ['Reynolds', 'Prandtl', 'Grashof', 'Nusselt', 'Sherwood', 'Rayleigh',
+'Schmidt', 'Peclet_heat', 'Peclet_mass', 'Fourier_heat', 'Fourier_mass',
+'Graetz_heat', 'Lewis', 'Weber', 'Mach', 'Knudsen',  'Bond',
+'Froude', 'Strouhal',  'Biot', 'Stanton', 'Euler', 'Cavitation', 'Eckert',
+'Jakob', 'Power_number', 'Drag', 'Capillary',
+'Archimedes', 'Ohnesorge', 'thermal_diffusivity', 'c_ideal_gas',
+'relative_roughness', 'nu_mu_converter', 'gravity',
 'K_from_f', 'K_from_L_equiv', 'dP_from_K', 'head_from_K', 'head_from_P',
 'P_from_head']
 

fluids/fittings.py

@@ -18,12 +18,13 @@
 from __future__ import division
 from math import cos, sin, tan, atan, pi
 
-__all__ = ['entrance_sharp', 'entrance_distance', 'entrance_angled',
-'entrance_rounded', 'entrance_beveled', 'exit_normal', 'bend_rounded',
-'bend_miter', 'helix', 'spiral', 'contraction_sharp', 'contraction_round',
-'contraction_conical', 'contraction_beveled', 'diffuser_sharp',
+__all__ = ['contraction_sharp', 'contraction_round',
+'contraction_conical', 'contraction_beveled',  'diffuser_sharp',
 'diffuser_conical', 'diffuser_conical_staged', 'diffuser_curved',
-'diffuser_pipe_reducer', 'Darby3K', 'Hooper2K', 'Kv_to_Cv', 'Cv_to_Kv',
+'diffuser_pipe_reducer',
+'entrance_sharp', 'entrance_distance', 'entrance_angled',
+'entrance_rounded', 'entrance_beveled', 'exit_normal', 'bend_rounded',
+'bend_miter', 'helix', 'spiral','Darby3K', 'Hooper2K', 'Kv_to_Cv', 'Cv_to_Kv',
 'Kv_to_K']
 
 ### Entrances

fluids/friction_factor.py

@@ -17,13 +17,13 @@
 
 from __future__ import division
 from math import log, log10, exp
-__all__ = ['fd', 'Moody', 'Alshul_1952', 'Wood_1966', 'Churchill_1973',
+__all__ = ['friction_factor', 'Moody', 'Alshul_1952', 'Wood_1966', 'Churchill_1973',
 'Eck_1973', 'Jain_1976', 'Swamee_Jain_1976', 'Churchill_1977', 'Chen_1979',
 'Round_1980', 'Shacham_1980', 'Barr_1981', 'Zigrang_Sylvester_1',
 'Zigrang_Sylvester_2', 'Haaland', 'Serghides_1', 'Serghides_2', 'Tsal_1989',
 'Manadilli_1997', 'Romeo_2002', 'Sonnad_Goudar_2006', 'Rao_Kumar_2007',
 'Buzzelli_2008', 'Avci_Karagoz_2009', 'Papaevangelo_2010', 'Brkic_2011_1',
-'Brkic_2011_2', 'Fang_2011', 'friction_factor']
+'Brkic_2011_2', 'Fang_2011']
 
 
 def Moody(Re, eD):
@@ -1340,7 +1340,7 @@ def friction_factor(Re=1E5, eD=1E-4, Method=None, Darcy=True, AvailableMethods=F
     r'''Calculates friction factor. Uses a specified method, or automatically
     picks one from the dictionary of available methods. 28 methods available,
     described in the table below. The default is more than sufficient
-    for all applications.
+    for all applications. Can also be accesed under the name `fd`.
 
     Examples
     --------

fluids/packed_bed.py

@@ -18,7 +18,8 @@
 from __future__ import division
 
 __all__ = ['Ergun', 'Kuo_Nydegger', 'Jones_Krier', 'Carman', 'Hicks',
-           'Brauer', 'Montillet', 'Idelchik']
+           'Brauer', 'Montillet', 'Idelchik', 'voidage_Benyahia_Oneil',
+           'voidage_Benyahia_Oneil_spherical', 'voidage_Benyahia_Oneil_cylindrical']
 
 
 def Ergun(Dp, voidage=0.4, sphericity=1, H=None, vs=None, rho=None, mu=None):
@@ -663,7 +664,7 @@ def voidage_Benyahia_Oneil_spherical(Dp, Dt):
     return voidage
 
 
-def voidage_Benyahia_Oneil_cylinderical(Dpe, Dt, sphericity):
+def voidage_Benyahia_Oneil_cylindrical(Dpe, Dt, sphericity):
     r'''Calculates voidage of a bed of cylindrical uniform particles
     packed into a bed or tube of diameter `Dt`, with equivalent sphere diameter
     `Dpe`. Shown in [1]_, and cited by various authors. Correlations exist
@@ -693,7 +694,7 @@ def voidage_Benyahia_Oneil_cylinderical(Dpe, Dt, sphericity):
 
     Examples
     --------
-    >>> voidage_Benyahia_Oneil_cylinderical(.01, .1, .6)
+    >>> voidage_Benyahia_Oneil_cylindrical(.01, .1, .6)
     0.38812523109607894
 
     References

fluids/pump.py

@@ -20,8 +20,8 @@
 from scipy.interpolate import interp1d, interp2d
 from scipy.constants import hp
 
-__all__ = ['Corripio_pump_efficiency', 'Corripio_motor_efficiency',
-'VFD_efficiency', 'CSA_motor_efficiency', 'motor_efficiency_underloaded',
+__all__ = ['VFD_efficiency', 'CSA_motor_efficiency', 'motor_efficiency_underloaded',
+'Corripio_pump_efficiency', 'Corripio_motor_efficiency',
 'specific_speed', 'specific_diameter', 'speed_synchronous', 'nema_sizes',
 'nema_sizes_hp', 'motor_round_size']
 
@@ -184,7 +184,11 @@ def VFD_efficiency(P, load=1):
 
 
 nema_sizes_hp = [.25, 1/3., .5, .75, 1, 1.5, 2, 3, 4, 5, 5.5, 7.5, 10, 15, 20, 25, 30, 40, 50, 60, 75, 100, 125, 150, 175, 200, 250, 300, 350, 400, 450, 500]
+'''list: all NEMA motor sizes, in hp.
+'''
 nema_sizes = [i*hp for i in nema_sizes_hp]
+'''list: all NEMA motor sizes, in Watts.
+'''
 
 def motor_round_size(P):
     r'''Rounds up the power for a motor to the nearest NEMA standard power.