UTide


NameUTide JSON
Version 0.3.0 PyPI version JSON
download
home_pagehttps://github.com/wesleybowman/UTide
SummaryPython distribution of the MatLab package UTide
upload_time2022-04-27 14:49:00
maintainer
docs_urlNone
authorWesley Bowman
requires_python>=3.6
licenseMIT
keywords oceanography tides
VCS
bugtrack_url
requirements numpy scipy
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/wesleybowman/UTide",
    "name": "UTide",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "oceanography tides",
    "author": "Wesley Bowman",
    "author_email": "wesley.bowman23@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/97/5b/1eda5ddab2201207fbf4ed8798750d0e96dc1f5b4ddfde979cb4e18ed49f/UTide-0.3.0.tar.gz",
    "platform": "any",
    "description": "UTide\n=====\n|travis| |license| |conda| |downloads| |anaconda_cloud| |appveyor|\n\n.. |travis| image:: https://travis-ci.org/wesleybowman/UTide.svg?branch=master\n   :target: https://travis-ci.org/wesleybowman/UTide\n\n.. |license| image:: https://anaconda.org/conda-forge/utide/badges/license.svg\n   :target: https://choosealicense.com/licenses/mit/\n\n.. |conda| image:: https://anaconda.org/conda-forge/utide/badges/installer/conda.svg\n   :target: https://anaconda.org/conda-forge/utide\n\n.. |downloads| image:: https://anaconda.org/conda-forge/utide/badges/downloads.svg\n   :target: https://anaconda.org/conda-forge/utide\n\n.. |anaconda_cloud| image:: https://anaconda.org/conda-forge/utide/badges/version.svg\n   :target: https://anaconda.org/conda-forge/utide\n\n.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/4o163ma4ehhr3q48/branch/master?svg=true\n   :target: https://ci.appveyor.com/project/wesleybowman/utide/branch/master\n\n\nPython re-implementation of the Matlab package UTide.\n\nStill in heavy development--everything is subject to change!\n\nNote: the user interface differs from the Matlab version, so\nconsult the Python function docstrings to see how to specify\nparameters. Some functionality from the Matlab version is\nnot yet available. For more information see:\n\n::\n\n    Codiga, D.L., 2011. Unified Tidal Analysis and Prediction Using the\n    UTide Matlab Functions. Technical Report 2011-01. Graduate School\n    of Oceanography, University of Rhode Island, Narragansett, RI.\n    59pp. ftp://www.po.gso.uri.edu/pub/downloads/codiga/pubs/\n    2011Codiga-UTide-Report.pdf\n\n    UTide v1p0 9/2011 d.codiga@gso.uri.edu\n     http://www.po.gso.uri.edu/~codiga/utide/utide.htm\n\nInstallation\n============\n\n.. code:: shell\n\n    pip install utide\n\nIf you are using conda,\n\n.. code:: shell\n\n    conda install utide -c conda-forge\n\n\nThe public functions can be imported using\n\n.. code:: python\n\n    from utide import solve, reconstruct\n\nA sample call would be\n\n.. code:: python\n\n    from utide import solve\n\n    coef = solve(time, time_series_u, time_series_v,\n                 lat=30,\n                 nodal=False,\n                 trend=False,\n                 method='ols',\n                 conf_int='linear',\n                 Rayleigh_min=0.95,)\n\n\nFor more examples see the\n`notebooks <https://nbviewer.jupyter.org/github/wesleybowman/UTide/tree/master/notebooks/>`__\nfolder.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python distribution of the MatLab package UTide",
    "version": "0.3.0",
    "project_urls": {
        "Homepage": "https://github.com/wesleybowman/UTide"
    },
    "split_keywords": [
        "oceanography",
        "tides"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9f78f749dfea1362e46b593245cc6cb1536070f4e0a4627c147fd9a9509c6c21",
                "md5": "b1818c9943957b2f0f6476d1d4ac8ff1",
                "sha256": "99f730b730a286501143561916c7c619ce4ca664bfc95ee9660ca7a5698d0ef3"
            },
            "downloads": -1,
            "filename": "UTide-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b1818c9943957b2f0f6476d1d4ac8ff1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 75227,
            "upload_time": "2022-04-27T14:48:57",
            "upload_time_iso_8601": "2022-04-27T14:48:57.381392Z",
            "url": "https://files.pythonhosted.org/packages/9f/78/f749dfea1362e46b593245cc6cb1536070f4e0a4627c147fd9a9509c6c21/UTide-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "975b1eda5ddab2201207fbf4ed8798750d0e96dc1f5b4ddfde979cb4e18ed49f",
                "md5": "a55149aef5396a2755f4bb3e97f39a43",
                "sha256": "911a41fd8c838ae8d6a0b09e2570e8d849c10b4fc7a078da2810d9d1a9d22429"
            },
            "downloads": -1,
            "filename": "UTide-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a55149aef5396a2755f4bb3e97f39a43",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 75193,
            "upload_time": "2022-04-27T14:49:00",
            "upload_time_iso_8601": "2022-04-27T14:49:00.631167Z",
            "url": "https://files.pythonhosted.org/packages/97/5b/1eda5ddab2201207fbf4ed8798750d0e96dc1f5b4ddfde979cb4e18ed49f/UTide-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-04-27 14:49:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wesleybowman",
    "github_project": "UTide",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": []
        }
    ],
    "lcname": "utide"
}
        
Elapsed time: 3.35740s