Skip to content

Commit

Permalink
Skip math for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ocefpaf committed Jul 2, 2015
1 parent f92c665 commit af210c2
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 22 deletions.
18 changes: 9 additions & 9 deletions seawater/eos80.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ def alpha(s, t, p, pt=False):
Returns
-------
alpha : array_like
thermal expansion coeff :math:`\alpha` [℃ :sup:`-1`]
thermal expansion coeff :math:`\\alpha` [℃ :sup:`-1`]
Examples
--------
Expand All @@ -141,7 +141,7 @@ def alpha(s, t, p, pt=False):

def aonb(s, t, p, pt=False):
"""
Calculate :math:`\alpha/\beta`.
Calculate :math:`\\alpha/\\beta`.
Parameters
----------
Expand All @@ -157,7 +157,7 @@ def aonb(s, t, p, pt=False):
Returns
-------
aonb : array_like
:math:`\alpha/\beta` [psu ℃ :sup:`-1`]
:math:`\\alpha/\\beta` [psu ℃ :sup:`-1`]
Examples
--------
Expand Down Expand Up @@ -202,7 +202,7 @@ def aonb(s, t, p, pt=False):

def beta(s, t, p, pt=False):
"""
Calculate the saline contraction coefficient :math:`\beta` as defined
Calculate the saline contraction coefficient :math:`\\beta` as defined
by T.J. McDougall.
Parameters
Expand Down Expand Up @@ -644,7 +644,7 @@ def pden(s, t, p, pr=0):
array([ 999.842594 , 999.79523994, 995.65113374, 996.36115932,
1028.10633141, 1028.15738545, 1021.72863949, 1022.59634627])
:math:`\sigma_{4}` (at 4000 db)
:math:`\\sigma_{4}` (at 4000 db)
>>> sw.pden(s, t, p, 4000) - 1000
array([ 19.2895493 , 19.33422519, 12.43271053, 13.27563816,
Expand Down Expand Up @@ -790,7 +790,7 @@ def salt(r, t, p):
Parameters
----------
r : array_like
conductivity ratio :math:`R = \frac{C(S,T,P)}{C(35,15(IPTS-68),0)}`
conductivity ratio :math:`R = \\frac{C(S,T,P)}{C(35,15(IPTS-68),0)}`
t : array_like
temperature [℃ (ITS-90)]
p : array_like
Expand All @@ -814,9 +814,9 @@ def salt(r, t, p):
References
----------
.. [1] Fofonoff, P. and Millard, R.C. Jr UNESCO 1983. Algorithms for
computation of fundamental properties of seawater. UNESCO Tech. Pap. in
Mar. Sci., No. 44, 53 pp. Eqn.(31) p.39.
.. [1] Fofonoff, P. and Millard, R.C. Jr UNESCO 1983. Algorithms for
computation of fundamental properties of seawater. UNESCO Tech. Pap.
in Mar. Sci., No. 44, 53 pp. Eqn.(31) p.39.
http://unesdoc.unesco.org/images/0005/000598/059832eb.pdf
"""
Expand Down
6 changes: 3 additions & 3 deletions seawater/extras.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,13 @@ def f(lat):
Calculates the Coriolis factor :math:`f` defined by:
.. math::
f = 2 \Omega \sin(lat)
f = 2 \\Omega \\sin(lat)
where:
.. math::
\Omega = \frac{2 \pi}{\textrm{sidereal day}} = 7.2921150e^{-5}
\textrm{ radians sec}^{-1}
\\Omega = \\frac{2 \\pi}{\\textrm{sidereal day}} = 7.2921150e^{-5}
\\textrm{ radians sec}^{-1}
Parameters
Expand Down
4 changes: 2 additions & 2 deletions seawater/geostrophic.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ def bfrq(s, t, p, lat=None):
depths from the equation:
.. math::
N^{2} = \frac{-g}{\sigma_{\theta}} \frac{d\sigma_{\theta}}{dz}
N^{2} = \\frac{-g}{\\sigma_{\\theta}} \\frac{d\\sigma_{\\theta}}{dz}
Also calculates Potential Vorticity from:
.. math::
q=f \frac{N^2}{g}
q = f \\frac{N^2}{g}
Parameters
----------
Expand Down
16 changes: 8 additions & 8 deletions seawater/library.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,20 +110,20 @@ def cndr(s, t, p):

def salds(rtx, delt):
"""
Calculates Salinity differential (:math:`\frac{dS}{d(\sqrt{Rt})}`) at
Calculates Salinity differential (:math:`\\frac{dS}{d(\\sqrt{Rt})}`) at
constant temperature.
Parameters
----------
rtx : array_like
:math:`\sqrt{rt}`
:math:`\\sqrt{rt}`
delt : array_like
t-15 [℃ (IPTS-68)]
Returns
-------
ds : array_like
:math:`\frac{dS}{d rtx}`
:math:`\\frac{dS}{d rtx}`
Examples
--------
Expand Down Expand Up @@ -160,13 +160,13 @@ def salrp(r, t, p):
Equation for Rp used in calculating salinity. UNESCO 1983 polynomial.
.. math::
Rp(S,T,P) = \frac{C(S,T,P)}{C(S,T,0)}
Rp(S,T,P) = \\frac{C(S,T,P)}{C(S,T,0)}
Parameters
----------
r : array_like
conductivity ratio :math:`R = \frac{C(S,T,P)}{C(35,15(IPTS-68),0)}`
conductivity ratio :math:`R = \\frac{C(S,T,P)}{C(35,15(IPTS-68),0)}`
t : array_like
temperature [℃ (ITS-90)]
p : array_like
Expand All @@ -175,7 +175,7 @@ def salrp(r, t, p):
Returns
-------
rp : array_like
conductivity ratio :math:`Rp(S,T,P) = \frac{C(S,T,P)}{C(S,T,0)}`
conductivity ratio :math:`Rp(S,T,P) = \\frac{C(S,T,P)}{C(S,T,0)}`
Examples
--------
Expand Down Expand Up @@ -210,7 +210,7 @@ def salrt(t):
Equation for rt used in calculating salinity. UNESCO 1983 polynomial.
.. math::
rt(t) = \frac{C(35,t,0)}{C(35,15(\textrm{IPTS-68}), 0)}
rt(t) = \\frac{C(35,t,0)}{C(35,15(\\textrm{IPTS-68}), 0)}
Parameters
Expand Down Expand Up @@ -329,7 +329,7 @@ def sals(rt, t):
Parameters
----------
rt : array_like
:math:`rt(s,t) = \frac{C(s,t,0)}{C(35, t(\textrm{IPTS-68}), 0)}`
:math:`rt(s,t) = \\frac{C(s,t,0)}{C(35, t(\\textrm{IPTS-68}), 0)}`
t : array_like
temperature [℃ (ITS-90)]
Expand Down

0 comments on commit af210c2

Please sign in to comment.