pyTMD

Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides.
https://github.com/pyTMD/pyTMD

Category: Hydrosphere
Sub Category: Ocean and Hydrology Data Access

Keywords

geodesy geophysics oceanography tides

Keywords from Contributors

earth-observation control routing virtual transform crop report simulations unitful weighted

Last synced: about 17 hours ago
JSON representation

Repository metadata

Python-based tidal prediction software

• Host: GitHub
• URL: https://github.com/pyTMD/pyTMD
• Owner: pyTMD
• License: mit
• Created: 2017-10-23T14:56:44.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2025-04-02T23:57:47.000Z (24 days ago)
• Last Synced: 2025-04-20T08:03:30.911Z (7 days ago)
• Topics: geodesy, geophysics, oceanography, tides
• Language: Python
• Homepage: https://pytmd.readthedocs.io
• Size: 19.2 MB
• Stars: 150
• Watchers: 8
• Forks: 44
• Open Issues: 12
• Releases: 47
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.rst
  • Citation: CITATION.cff

README.rst

          =====
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 `_

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 `_
- `lxml: processing XML and HTML in Python `_
- `netCDF4: Python interface to the netCDF C library `_
- `numpy: Scientific Computing Tools For Python `_
- `pyproj: Python interface to PROJ library `_
- `scipy: Scientific Tools for Python `_
- `setuptools_scm: manager for python package versions using scm metadata `_
- `timescale: Python tools for time and astronomical calculations `_

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 `_

    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 `_

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 `_ and `discussions board `_.

Credits
#######

The Tidal Model Driver (`TMD `_) Matlab Toolbox was developed by Laurie Padman, Lana Erofeeva and Susan Howard.
An updated version of the TMD Matlab Toolbox (`TMD3 `_) was developed by Chad Greene.
The OSU Tidal Inversion Software (OTIS) and OSU Tidal Prediction Software (`OTPS `_) were developed by Lana Erofeeva and Gary Egbert (`copyright OSU `_, 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 `_) was developed by Richard Ray.

License
#######

The content of this project is licensed under the `Creative Commons Attribution 4.0 Attribution license `_ and the source code is licensed under the `MIT license `_.

        

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: pyTMD
message: Python-based tidal prediction software
type: software
authors:
  - given-names: Tyler
    family-names: Sutterley
    affiliation: University of Washington, Applied Physics Laboratory
  - given-names: Karen
    family-names: Alley
    affiliation: University of Manitoba
  - given-names: Robbi
    family-names: Bishop-Taylor
    affiliation: Geoscience Australia
  - given-names: Kelly
    family-names: Brunt
    affiliation: NASA Goddard Space Flight Center
  - given-names: Susan
    family-names: Howard
    affiliation: Earth & Space Research
  - given-names: Laurie
    family-names: Padman
    affiliation: Earth & Space Research
  - given-names: Matthew
    family-names: Siegfried
    affiliation: Colorado School of Mines
identifiers:
  - type: doi
    value: 10.5281/zenodo.5555395
    description: Zenodo Archive
repository-code: 'https://github.com/pyTMD/pyTMD'
url: 'https://pytmd.readthedocs.io'
repository: 'https://pypi.org/project/pyTMD'
repository-artifact: 'https://anaconda.org/conda-forge/pytmd'
doi: "10.5281/zenodo.5555395"
version: "2.2.3"
date-released: "2025-04-02"
keywords:
  - Ocean Tides
  - Load Tides
  - Pole Tides
  - Solid Earth Tides
  - Tidal Prediction
license: MIT

---

Owner metadata

• Name: pyTMD
• Login: pyTMD
• Email:
• Kind: organization
• Description:
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/199183018?v=4
• Repositories: 1
• Last ynced at: 2025-02-16T22:25:01.813Z
• Profile URL: https://github.com/pyTMD

---

GitHub Events

Total

• Create event: 16
• Issues event: 7
• Release event: 2
• Watch event: 8
• Delete event: 15
• Issue comment event: 16
• Push event: 89
• Pull request review event: 2
• Pull request event: 30
• Fork event: 8

Last Year

• Create event: 16
• Issues event: 7
• Release event: 2
• Watch event: 8
• Delete event: 15
• Issue comment event: 16
• Push event: 89
• Pull request review event: 2
• Pull request event: 30
• Fork event: 8

---

Committers metadata

Last synced: 6 days ago

Name	Email	Commits
Tyler Sutterley	t****l@u****u	289
github-actions[bot]	4****]	96
tsutterley	t****y@n****v	4
Robbi Bishop-Taylor	R****r@g****u	3

Committer domains:

• ga.gov.au: 1
• nasa.gov: 1
• uw.edu: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/pyTMD/pyTMD

---

---

---

Package metadata

• Total packages: 2
• Total downloads:
  • pypi: 4,873 last-month
• Total dependent packages: 0 (may contain duplicates)
• Total dependent repositories: 9 (may contain duplicates)
• Total versions: 68
• Total maintainers: 1

---

Dependencies

Score: 14.967405760413934