Metadata-Version: 2.4
Name: pyTMD
Version: 2.2.6
Summary: Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides
Author: Tyler Sutterley
Author-email: tsutterl@uw.edu
Maintainer: pyTMD contributors
License: MIT License
        
        Copyright (c) 2017 Tyler C Sutterley
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://pytmd.readthedocs.io
Project-URL: Documentation, https://pytmd.readthedocs.io
Project-URL: Repository, https://github.com/pyTMD/pyTMD
Project-URL: Issues, https://github.com/pyTMD/pyTMD/issues
Keywords: Ocean Tides,Load Tides,Pole Tides,Solid Earth Tides,Tidal Prediction
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Oceanography
Requires-Python: ~=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: lxml
Requires-Dist: netCDF4
Requires-Dist: numpy
Requires-Dist: pyproj
Requires-Dist: python-dateutil
Requires-Dist: scipy>=1.10.1
Requires-Dist: setuptools_scm
Requires-Dist: timescale>=0.0.8
Provides-Extra: doc
Requires-Dist: docutils; extra == "doc"
Requires-Dist: fontconfig; extra == "doc"
Requires-Dist: freetype; extra == "doc"
Requires-Dist: graphviz; extra == "doc"
Requires-Dist: myst-nb; extra == "doc"
Requires-Dist: numpydoc; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-argparse>=0.4; extra == "doc"
Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
Requires-Dist: sphinx-design; extra == "doc"
Requires-Dist: sphinx_rtd_theme; extra == "doc"
Provides-Extra: all
Requires-Dist: cartopy; extra == "all"
Requires-Dist: ipyleaflet; extra == "all"
Requires-Dist: ipywidgets; extra == "all"
Requires-Dist: jplephem; extra == "all"
Requires-Dist: matplotlib; extra == "all"
Requires-Dist: notebook; extra == "all"
Requires-Dist: pandas; extra == "all"
Provides-Extra: dev
Requires-Dist: flake8; extra == "dev"
Requires-Dist: pytest>=4.6; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: oct2py; extra == "dev"
Requires-Dist: boto3; extra == "dev"
Dynamic: license-file

=====
pyTMD
=====

|License|
|Documentation Status|
|PyPI|
|conda-forge|
|commits-since|
|zenodo|

.. |License| image:: https://img.shields.io/github/license/pyTMD/pyTMD
   :target: https://github.com/pyTMD/pyTMD/blob/main/LICENSE

.. |Documentation Status| image:: https://readthedocs.org/projects/pytmd/badge/?version=latest
   :target: https://pytmd.readthedocs.io/en/latest/?badge=latest

.. |PyPI| image:: https://img.shields.io/pypi/v/pyTMD.svg
   :target: https://pypi.python.org/pypi/pyTMD/

.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pytmd
   :target: https://anaconda.org/conda-forge/pytmd

.. |commits-since| image:: https://img.shields.io/github/commits-since/pyTMD/pyTMD/latest
   :target: https://github.com/pyTMD/pyTMD/releases/latest

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5555395.svg
   :target: https://doi.org/10.5281/zenodo.5555395

Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides

For more information: see the documentation at `pytmd.readthedocs.io <https://pytmd.readthedocs.io/>`_

Installation
############

From PyPI:

.. code-block:: bash

   python3 -m pip install pyTMD

To include all optional dependencies:

.. code-block:: bash

   python3 -m pip install pyTMD[all]

Using `conda` or `mamba` from conda-forge:

.. code-block:: bash

   conda install -c conda-forge pytmd

.. code-block:: bash

   mamba install -c conda-forge pytmd

Development version from GitHub:

.. code-block:: bash

   python3 -m pip install git+https://github.com/pyTMD/pyTMD.git

Dependencies
############

- `dateutil: powerful extensions to datetime <https://dateutil.readthedocs.io/en/stable/>`_
- `lxml: processing XML and HTML in Python <https://pypi.python.org/pypi/lxml>`_
- `netCDF4: Python interface to the netCDF C library <https://unidata.github.io/netcdf4-python/>`_
- `numpy: Scientific Computing Tools For Python <https://www.numpy.org>`_
- `pyproj: Python interface to PROJ library <https://pypi.org/project/pyproj/>`_
- `scipy: Scientific Tools for Python <https://www.scipy.org/>`_
- `setuptools_scm: manager for python package versions using scm metadata <https://pypi.org/project/setuptools-scm>`_
- `timescale: Python tools for time and astronomical calculations <https://pypi.org/project/timescale/>`_

References
##########

    T. C. Sutterley, T. Markus, T. A. Neumann, M. R. van den Broeke, J. M. van Wessem, and S. R. M. Ligtenberg,
    "Antarctic ice shelf thickness change from multimission lidar mapping", *The Cryosphere*,
    13, 1801-1817, (2019). `doi: 10.5194/tc-13-1801-2019 <https://doi.org/10.5194/tc-13-1801-2019>`_

    L. Padman, M. R. Siegfried, H. A. Fricker,
    "Ocean Tide Influences on the Antarctic and Greenland Ice Sheets", *Reviews of Geophysics*,
    56, 142-184, (2018). `doi: 10.1002/2016RG000546 <https://doi.org/10.1002/2016RG000546>`_

Download
########

| The program homepage is:
| https://github.com/pyTMD/pyTMD
| A zip archive of the latest version is available directly at:
| https://github.com/pyTMD/pyTMD/archive/main.zip

Alternative Software
####################

| perth5 from NASA Goddard Space Flight Center:
| https://codeberg.org/rray/perth5
| Matlab Tide Model Driver from Earth & Space Research:
| https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5
| Fortran OSU Tidal Prediction Software:
| https://www.tpxo.net/otps

Disclaimer
##########

This package includes software developed at NASA Goddard Space Flight Center (GSFC) and the University of Washington Applied Physics Laboratory (UW-APL).
It is not sponsored or maintained by the Universities Space Research Association (USRA), AVISO or NASA.
The software is provided here for your convenience but *with no guarantees whatsoever*.
It should not be used for coastal navigation or any application that may risk life or property.

Contributing
############

This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
If you would like to contribute to the project, please have a look at the `open issues <https://github.com/pyTMD/pyTMD/issues>`_ and `discussions board <https://github.com/pyTMD/pyTMD/discussions>`_.

Credits
#######

The Tidal Model Driver (`TMD <https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5>`_) Matlab Toolbox was developed by Laurie Padman, Lana Erofeeva and Susan Howard.
An updated version of the TMD Matlab Toolbox (`TMD3 <https://github.com/chadagreene/Tide-Model-Driver>`_) was developed by Chad Greene.
The OSU Tidal Inversion Software (OTIS) and OSU Tidal Prediction Software (`OTPS <https://www.tpxo.net/otps>`_) were developed by Lana Erofeeva and Gary Egbert (`copyright OSU <https://www.tpxo.net/tpxo-products-and-registration>`_, licensed for non-commercial use).
The NASA Goddard Space Flight Center (GSFC) PREdict Tidal Heights (PERTH3) software was developed by Richard Ray and Remko Scharroo.
An updated and more versatile version of the NASA GSFC tidal prediction software (`PERTH5 <https://codeberg.org/rray/perth5>`_) was developed by Richard Ray.

License
#######

The content of this project is licensed under the `Creative Commons Attribution 4.0 Attribution license <https://creativecommons.org/licenses/by/4.0/>`_ and the source code is licensed under the `MIT license <LICENSE>`_.
