tau doctsring

src/tools21cm/tau.py

@@ -26,17 +26,6 @@ def tau(ionfractions, redshifts, num_points = 50):
 		* The Universe is assumed to be fully ionized at the lowest redshift supplied.
 		* To get the total optical depth, look at the last value in tau_0
 		
-	Example:
-		To calculate the optical depth for a scenario where the Universe is instantaneously
-		reionized:
-		
-		>>> z_reion = 11.
-		>>> redshifts = np.linspace(z_reion, 1100., 50)
-		>>> ionfracs = np.zeros(len(redshifts))
-		>>> tau0, tau_z = tau(ionfracs, redshifts)
-		>>> print 'Total tau: ', tau0[-1]
-		0.0884755058758
-		
 	'''
 
 	if len(ionfractions) != len(redshifts):

tests/test_optical_depth.py

@@ -0,0 +1,20 @@
+import numpy as np 
+import tools21cm as t2c 
+
+def test_Thomson_optical_depth():
+    """	
+    To calculate the optical depth for a scenario where the Universe is instantaneously
+    reionized:
+
+    >>> z_reion = 11.
+    >>> redshifts = np.linspace(z_reion, 1100., 50)
+    >>> ionfracs = np.zeros(len(redshifts))
+    >>> tau0, tau_z = tau(ionfracs, redshifts)
+    >>> print 'Total tau: ', tau0[-1]
+    0.0884755058758
+    """
+    z_reion = 11.
+    redshifts = np.linspace(z_reion, 1100., 50)
+    ionfracs = np.zeros(len(redshifts))
+    tau0, tau_z = t2c.tau(ionfracs, redshifts)
+    assert np.abs(tau0[-1]-0.0884755058758)<0.01