mocsy documentation using mocsy from IOOS channel

In [1]:

    

import mocsy


    

In [2]:

    

mocsy.__version__


    

    
Out[2]:





'2.0.1'

In [3]:

    

print(dir(mocsy))


    

    




['__all__', '__builtins__', '__doc__', '__file__', '__name__', '__package__', '__path__', '__version__', '_mocsy', 'absolute_import', 'gasx', 'mconstants', 'mdepth2press', 'mf2pco2', 'mp2fco2', 'mp80', 'mphsolvers', 'mrho', 'mrhoinsitu', 'msingledouble', 'msw_adtg', 'msw_ptmp', 'msw_temp', 'mtis', 'mtpot', 'mvars', 'mvarsolver']

In [4]:

    

dir(mocsy.mp2fco2)


    

    
Out[4]:





['p2fco2']

In [5]:

    

dir(mocsy.gasx)


    

    
Out[5]:





['flxco2', 'pco2atm2xco2', 'scco2', 'vapress', 'x2pco2atm']

In [6]:

    

print(mocsy.gasx.x2pco2atm.__doc__)


    

    




pco2atm = x2pco2atm(xco2,temp,salt,patm,[n])

Wrapper for ``x2pco2atm``.

Parameters
----------
xco2 : input rank-1 array('f') with bounds (n)
temp : input rank-1 array('f') with bounds (n)
salt : input rank-1 array('f') with bounds (n)
patm : input rank-1 array('f') with bounds (n)

Other Parameters
----------------
n : input int, optional
    Default: len(xco2)

Returns
-------
pco2atm : rank-1 array('f') with bounds (n)

In [7]:

    

dir(mocsy.mvars)


    

    
Out[7]:





['vars']

In [8]:

    

print(mocsy.mvars.__doc__)


    

    




ph,pco2,fco2,co2,hco3,co3,omegaa,omegac,betad,rhosw,p,tempis = vars(temp,sal,alk,dic,sil,phos,patm,depth,lat,optcon,optt,optp,[n,optb,optk1k2,optkf,optgas])

Wrapper for ``vars``.

Parameters
----------
temp : input rank-1 array('f') with bounds (n)
sal : input rank-1 array('f') with bounds (n)
alk : input rank-1 array('f') with bounds (n)
dic : input rank-1 array('f') with bounds (n)
sil : input rank-1 array('f') with bounds (n)
phos : input rank-1 array('f') with bounds (n)
patm : input rank-1 array('f') with bounds (n)
depth : input rank-1 array('f') with bounds (n)
lat : input rank-1 array('f') with bounds (n)
optcon : input string(len=6)
optt : input string(len=7)
optp : input string(len=2)

Other Parameters
----------------
n : input int, optional
    Default: len(temp)
optb : input string(len=3), optional
    Default: 'l10'
optk1k2 : input string(len=3), optional
    Default: 'l'
optkf : input string(len=2), optional
    Default: 'pf'
optgas : input string(len=7), optional
    Default: 'pinsitu'

Returns
-------
ph : rank-1 array('f') with bounds (n)
pco2 : rank-1 array('f') with bounds (n)
fco2 : rank-1 array('f') with bounds (n)
co2 : rank-1 array('f') with bounds (n)
hco3 : rank-1 array('f') with bounds (n)
co3 : rank-1 array('f') with bounds (n)
omegaa : rank-1 array('f') with bounds (n)
omegac : rank-1 array('f') with bounds (n)
betad : rank-1 array('f') with bounds (n)
rhosw : rank-1 array('f') with bounds (n)
p : rank-1 array('f') with bounds (n)
tempis : rank-1 array('f') with bounds (n)

In [ ]: