Metadata-Version: 1.1
Name: UTide
Version: 0.2.4
Summary: Python distribution of the MatLab package UTide.
Home-page: https://github.com/wesleybowman/UTide
Author: ['Wesley Bowman']
Author-email: wesley.bowman23@gmail.com
License: MIT
Description: UTide
        =====
        |travis| |license| |conda| |downloads| |anaconda_cloud| |appveyor|
        
        .. |travis| image:: https://travis-ci.org/wesleybowman/UTide.svg?branch=master
           :target: https://travis-ci.org/wesleybowman/UTide
        
        .. |license| image:: https://anaconda.org/conda-forge/utide/badges/license.svg
           :target: https://choosealicense.com/licenses/mit/
        
        .. |conda| image:: https://anaconda.org/conda-forge/utide/badges/installer/conda.svg
           :target: https://anaconda.org/conda-forge/utide
        
        .. |downloads| image:: https://anaconda.org/conda-forge/utide/badges/downloads.svg
           :target: https://anaconda.org/conda-forge/utide
        
        .. |anaconda_cloud| image:: https://anaconda.org/conda-forge/utide/badges/version.svg
           :target: https://anaconda.org/conda-forge/utide
        
        .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/4o163ma4ehhr3q48/branch/master?svg=true
           :target: https://ci.appveyor.com/project/wesleybowman/utide/branch/master
        
        
        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 d.codiga@gso.uri.edu
             http://www.po.gso.uri.edu/~codiga/utide/utide.htm
        
        Installation
        ============
        
        .. code:: shell
        
            pip install utide
        
        If you are using conda,
        
        .. code:: shell
        
            conda install utide -c conda-forge
        
        
        The public functions can be imported using
        
        .. code:: python
        
            from utide import solve, reconstruct
        
        A sample call would be
        
        .. code:: python
        
            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 <https://nbviewer.jupyter.org/github/wesleybowman/UTide/tree/master/notebooks/>`__
        folder.
        
Keywords: oceanography,tides
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Education
