use raw string when docs contain math

Author: kaklise

pecos/metrics.py

@@ -9,7 +9,7 @@
 logger = logging.getLogger(__name__)
 
 def qci(mask, tfilter=None):
-    """
+    r"""
     Compute the quality control index (QCI) for each column, defined as:
     
     :math:`QCI=\dfrac{\sum_{t\in T}X_{dt}}{|T|}`
@@ -42,7 +42,7 @@ def qci(mask, tfilter=None):
     return qci   
 
 def rmse(data1, data2, tfilter=None):
-    """
+    r"""
     Compute the root mean squared error (RMSE) for each column, defined as:
     
     :math:`RMSE=\sqrt{\dfrac{\sum{(data_1-data_2)^2}}{n}}`
@@ -86,7 +86,7 @@ def rmse(data1, data2, tfilter=None):
     return rmse
 
 def time_integral(data, tfilter=None):
-    """
+    r"""
     Compute the time integral (F) for each column, defined as:
     
     :math:`F=\int{fdt}`
@@ -131,7 +131,7 @@ def time_integral(data, tfilter=None):
     return F
 
 def time_derivative(data, tfilter=None):
-    """
+    r"""
     Compute the derivative (f') of each column, defined as:
     
     :math:`f'=\dfrac{df}{dt}`
@@ -170,7 +170,7 @@ def time_derivative(data, tfilter=None):
     return f
 
 def probability_of_detection(observed, actual, tfilter=None):
-    """ 
+    r""" 
     Compute probability of detection (PD) for each column, defined as:
         
     :math:`PD=\dfrac{TP}{TP+FN}`
@@ -228,7 +228,7 @@ def probability_of_detection(observed, actual, tfilter=None):
     return PD
 
 def false_alarm_rate(observed, actual, tfilter=None):
-    """ 
+    r""" 
     Compute false alarm rate (FAR) for each column, defined as:
         
     :math:`FAR=\dfrac{TN}{TN+FP}`

pecos/pv.py

@@ -8,7 +8,7 @@
 logger = logging.getLogger(__name__)
 
 def insolation(G, tfilter=None):
-    """
+    r"""
     Compute insolation defined as:
     
     :math:`H=\int{Gdt}`
@@ -38,7 +38,7 @@ def insolation(G, tfilter=None):
     return H
 
 def energy(P, tfilter=None):
-    """
+    r"""
     Convert energy defined as:
     
     :math:`E=\int{Pdt}`
@@ -68,7 +68,7 @@ def energy(P, tfilter=None):
     return E
 
 def performance_ratio(E, H_poa, P_ref, G_ref=1000):
-    """
+    r"""
     Compute performance ratio defined as:
 
     :math:`PR=\dfrac{Y_{f}}{Yr} = \dfrac{\dfrac{E}{P_{ref}}}{\dfrac{H_{poa}}{G_{ref}}}`
@@ -107,7 +107,7 @@ def performance_ratio(E, H_poa, P_ref, G_ref=1000):
     return PR
 
 def normalized_current(I, G_poa, I_sco, G_ref=1000):
-    """
+    r"""
     Compute normalized current defined as:
 
     :math:`NI = \dfrac{\dfrac{I}{I_{sco}}}{\dfrac{G_{poa}}{G_{ref}}}`
@@ -146,7 +146,7 @@ def normalized_current(I, G_poa, I_sco, G_ref=1000):
     return NI
 
 def normalized_efficiency(P, G_poa, P_ref, G_ref=1000):
-    """
+    r"""
     Compute normalized efficiency defined as:
 
     :math:`NE = \dfrac{\dfrac{P}{P_{ref}}}{\dfrac{G_{poa}}{G_{ref}}}`
@@ -185,7 +185,7 @@ def normalized_efficiency(P, G_poa, P_ref, G_ref=1000):
     return NE
 
 def performance_index(E, E_predicted):
-    """
+    r"""
     Compute performance index defined as:
     
     :math:`PI=\dfrac{E}{\hat{E}}`
@@ -220,7 +220,7 @@ def performance_index(E, E_predicted):
     return PI
 
 def energy_yield(E, P_ref):
-    """
+    r"""
     Compute energy yield is defined as:
     
     :math:`EY=\dfrac{E}{P_{ref}}`
@@ -248,7 +248,7 @@ def energy_yield(E, P_ref):
     return EY
 
 def clearness_index(H_dn, H_ea):
-    """
+    r"""
     Compute clearness index defined as:
     
     :math:`Kt=\dfrac{H_{dn}}{H_{ea}}`