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 standardization file-upload weighted interpreter unitful simulations report ocean-model crop

Last synced: about 22 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 (about 8 years ago)
Default Branch: main
Last Pushed: 2025-11-22T02:06:01.000Z (about 1 month ago)
Last Synced: 2025-11-22T04:06:42.285Z (about 1 month ago)
Topics: geodesy, geophysics, oceanography, tides
Language: Python
Homepage: https://pytmd.readthedocs.io
Size: 22.5 MB
Stars: 182
Watchers: 7
Forks: 57
Open Issues: 17
Releases: 53
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff

pyTMD

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:

python3 -m pip install pyTMD

To include all optional dependencies:

python3 -m pip install pyTMD[all]

Using conda or mamba from conda-forge:

conda install -c conda-forge pytmd

mamba install -c conda-forge pytmd

Development version from GitHub:

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

Running with Pixi

Alternatively, you can use Pixi for a streamlined workspace environment:

Install Pixi following the installation instructions
Clone the project repository:

git clone https://github.com/pyTMD/pyTMD.git

Move into the pyTMD directory

cd pyTMD

Install dependencies and start JupyterLab:

pixi run start

This will automatically create the environment, install all dependencies, and launch JupyterLab in the notebooks directory.

Dependencies

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.
If you would like to contribute to the project, please have a look at the contribution guidelines, 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.3.0
title: pyTMD
abstract: Python-based tidal prediction software
type: software
keywords:
  - Ocean Tides
  - Load Tides
  - Pole Tides
  - Solid Earth Tides
  - Tidal Prediction
license: MIT
version: "3.0.0"
date-released: "2025-12-12"
message: If you use this software, please consider citing our article
  in the Journal of Open Source Software.

authors:
  - given-names: Tyler
    family-names: Sutterley
    affiliation: University of Washington, Applied Physics Laboratory
  - 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

contributors:
  - 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: National Science Foundation

contact:
- family-names: Sutterley
  given-names: Tyler C.
  orcid: "https://orcid.org/0000-0002-6964-1194"

identifiers:
  - type: doi
    value: 10.5281/zenodo.5555395
    description: Persistent identifier for pyTMD
  - type: url
    value: https://github.com/pyTMD/pyTMD
    description: GitHub repository for pyTMD
  - type: url
    value: https://pypi.org/project/pyTMD
    description: pyTMD on PyPI
  - type: url
    value: https://anaconda.org/conda-forge/pytmd
    description: pyTMD on conda-forge
  - type: doi
    value: 10.21105/joss.08566
    description: JOSS article for pyTMD
repository-code: "https://github.com/pyTMD/pyTMD"
url: "https://pytmd.readthedocs.io"
doi: "10.5281/zenodo.5555395"

preferred-citation:
  authors:
  - family-names: Sutterley
    given-names: Tyler C.
    orcid: "https://orcid.org/0000-0002-6964-1194"
  - family-names: Howard
    given-names: Susan L.
    orcid: "https://orcid.org/0000-0002-9183-0178"
  - family-names: Padman
    given-names: Laurie
    orcid: "https://orcid.org/0000-0003-2010-642X"
  - family-names: Siegfried
    given-names: Matthew R.
    orcid: "https://orcid.org/0000-0002-0868-4633"
  date-published: 2025-12-15
  doi: 10.21105/joss.08566
  issn: 2475-9066
  issue: 116
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 8566
  title: "pyTMD: Python-based tidal prediction software"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.08566"
  volume: 10

references:
  - type: grant
    title: "Investigating Antarctic grounding zones using ICESat-2"
    institution:
      name: National Aeronautics and Space Administration
    number: 80NSSC22K0379
    authors:
      - given-names: Tyler
        family-names: Sutterley
      - given-names: Kelly
        family-names: Brunt
  - type: software
    title: "TMD Matlab Toolbox"
    version: 2.5
    repository-code: "https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5"
    authors:
      - given-names: Susan
        family-names: Howard
      - given-names: Laurie
        family-names: Padman
      - given-names: Lana
        family-names: Erofeeva
  - type: software
    title: "perth: Tide prediction from model grids"
    version: 5
    repository-code: "https://codeberg.org/rray/perth5"
    authors:
      - given-names: Richard
        family-names: Ray
  - type: software
    title: "OTPS: OSU Tidal Prediction Software"
    version: 2024
    repository-code: "https://www.tpxo.net/otps"
    authors:
      - given-names: Gary
        family-names: Egbert
      - given-names: Lana
        family-names: Erofeeva

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

Discussion event: 1
Create event: 58
Issues event: 23
Release event: 6
Watch event: 31
Delete event: 53
Issue comment event: 69
Push event: 356
Pull request review comment event: 10
Pull request review event: 12
Pull request event: 94
Fork event: 14

Last Year

Discussion event: 1
Create event: 58
Issues event: 23
Release event: 6
Watch event: 31
Delete event: 53
Issue comment event: 69
Push event: 356
Pull request review comment event: 10
Pull request review event: 12
Pull request event: 94
Fork event: 14

Committers metadata

Last synced: 8 days ago

Total Commits: 473
Total Committers: 7
Avg Commits per committer: 67.571
Development Distribution Score (DDS): 0.226

Commits in past year: 116
Committers in past year: 5
Avg Commits per committer in past year: 23.2
Development Distribution Score (DDS) in past year: 0.043

Name	Email	Commits
Tyler Sutterley	t**l@u**u	366
github-actions[bot]	4****]	96
Robbi Bishop-Taylor	R**r@g**u	4
tsutterley	t**y@n**v	4
Paul Branson	p**n@g**m	1
Kurt Schwehr	s**r@g**m	1
Guilherme Castelão	g**e@c**t	1

Committer domains:

Issue and Pull Request metadata

Last synced: 8 days ago

Total issues: 36
Total pull requests: 213
Average time to close issues: 6 months
Average time to close pull requests: 4 days
Total issue authors: 20
Total pull request authors: 8
Average comments per issue: 2.67
Average comments per pull request: 0.73
Merged pull request: 184
Bot issues: 0
Bot pull requests: 9

Past year issues: 14
Past year pull requests: 94
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 2 days
Past year issue authors: 6
Past year pull request authors: 7
Past year average comments per issue: 2.07
Past year average comments per pull request: 0.63
Past year merged pull request: 68
Past year bot issues: 0
Past year bot pull requests: 0

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

Top Issue Authors

robbibt (6)
ludwigus (5)
rcaneill (3)
castelao (3)
tsutterley (3)
alexguyot (2)
Alerovere (1)
bjarnebuchmann (1)
tommy307507 (1)
kadir-orhan (1)
JoaoLopez (1)
tonystevenj (1)
3enedix (1)
aragong (1)
carlosmry (1)

Top Pull Request Authors

tsutterley (193)
github-actions[bot] (9)
castelao (2)
mrsiegfried (2)
robbibt (2)
pbranson (2)
schwehr (2)
alexgleith (1)

Top Issue Labels

good first issue (4)
enhancement (3)
question (1)

Top Pull Request Labels

bug (1)

Package metadata

Total packages: 2
Total downloads:
- pypi: 15,248 last-month
Total docker downloads: 25
Total dependent packages: 0 (may contain duplicates)
Total dependent repositories: 9 (may contain duplicates)
Total versions: 76
Total maintainers: 1

pypi.org: pytmd

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

Homepage: https://pytmd.readthedocs.io
Documentation: https://pytmd.readthedocs.io
Licenses: 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.
Latest release: 3.0.0 (published 21 days ago)
Last Synced: 2025-12-13T02:33:07.529Z (13 days ago)
Versions: 68
Dependent Packages: 0
Dependent Repositories: 7
Downloads: 15,248 Last month
Docker Downloads: 25
Rankings:
- Downloads: 5.463%
- Dependent repos count: 5.556%
- Average: 7.116%
- Forks count: 7.142%
- Stargazers count: 7.348%
- Dependent packages count: 10.069%
Maintainers (1)
- tsutterley

conda-forge.org: pytmd

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

Homepage: https://github.com/pyTMD/pyTMD
Licenses: MIT
Latest release: 1.1.2 (published about 3 years ago)
Last Synced: 2025-12-01T10:01:58.061Z (25 days ago)
Versions: 8
Dependent Packages: 0
Dependent Repositories: 2
Rankings:
- Dependent repos count: 20.226%
- Average: 37.104%
- Forks count: 38.001%
- Stargazers count: 38.6%
- Dependent packages count: 51.589%

Dependencies

.github/workflows/python-publish.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/python-request.yml actions

actions/checkout v2 composite
actions/upload-artifact v2 composite
codecov/codecov-action v1 composite
conda-incubator/setup-miniconda v2 composite

pyproject.toml pypi

h5netcdf *
lxml *
numpy *
pint *
platformdirs *
pyproj >=2.5.0
scipy >=1.10.1
timescale >=0.0.8
xarray *

.github/workflows/joss-draft-pdf.yml actions

actions/checkout v4 composite
actions/upload-artifact v4 composite
openjournals/openjournals-draft-action master composite

.github/workflows/update-provider-database.yml actions

actions/checkout v4 composite
prefix-dev/setup-pixi v0.9.1 composite

Score: 16.873776782346596

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

pyTMD

Keywords

Keywords from Contributors

Repository metadata

README.md

pyTMD

Installation

Running with Pixi

Dependencies

References

Download

Alternative Software

Disclaimer

Contributing

Credits

License

Citation (CITATION.cff)

Owner metadata

GitHub Events

Total

Last Year

Committers metadata

Committer domains:

Issue and Pull Request metadata

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

pypi.org: pytmd

conda-forge.org: pytmd

Dependencies