Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 2.16 KB

README.rst

File metadata and controls

78 lines (52 loc) · 2.16 KB
Raw

UTide

travis license conda downloads anaconda_cloud

Python re-implementation of the Matlab package UTide.

Still in heavy development--everything is subject to change!

Note: the user interface differs from the Matlab version, so consult the Python function docstrings to see how to specify parameters. Some functionality from the Matlab version is not yet available.

% For more information see:
% Codiga, D.L., 2011. Unified Tidal Analysis and Prediction Using the
% UTide Matlab Functions. Technical Report 2011-01. Graduate School
% of Oceanography, University of Rhode Island, Narragansett, RI.
% 59pp. ftp://www.po.gso.uri.edu/pub/downloads/codiga/pubs/
% 2011Codiga-UTide-Report.pdf
%
% UTide v1p0 9/2011 [email protected]
% http://www.po.gso.uri.edu/~codiga/utide/utide.htm

Installation

pip install utide

If you are using conda,

conda install utide -c conda-forge

The public functions can be imported using

from utide import solve, reconstruct

A sample call would be

from utide import solve

coef = solve(time, time_series_u, time_series_v,
             lat=30,
             nodal=False,
             trend=False,
             method='ols',
             conf_int='linear',
             Rayleigh_min=0.95,)

For more examples see the notebooks folder.