pytmd

Python-based tidal prediction software

https://github.com/pytmd/pytmd

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 9 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
2 of 6 committers (33.3%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary

Keywords

geodesy geophysics oceanography tides

Keywords from Contributors

interpretability standardization hack

Last synced: 6 months ago · JSON representation ·

Repository

Python-based tidal prediction software

Basic Info

Host: GitHub
Owner: pyTMD
License: mit
Language: Python
Default Branch: main
Homepage: https://pytmd.readthedocs.io
Size: 21.7 MB

Statistics

Stars: 175
Watchers: 8
Forks: 54
Open Issues: 18
Releases: 51

Topics

geodesy geophysics oceanography tides

Created over 8 years ago · Last pushed 6 months ago

Metadata Files

Readme License Code of conduct Citation

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:

bash python3 -m pip install pyTMD

To include all optional dependencies:

bash python3 -m pip install pyTMD[all]

Using conda or mamba from conda-forge:

bash conda install -c conda-forge pytmd

bash mamba install -c conda-forge pytmd

Development version from GitHub:

bash 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:

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

Move into the pyTMD directory

bash cd pyTMD

Install dependencies and start JupyterLab:

bash 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.

Owner

Name: pyTMD
Login: pyTMD
Kind: organization

Repositories: 1
Profile: https://github.com/pyTMD

JOSS Publication

pyTMD: Python-based tidal prediction software

Published

December 15, 2025

DOI

10.21105/joss.08566

Volume 10, Issue 116, Page 8566

Authors

Tyler C. Sutterley

Polar Science Center, Applied Physics Laboratory, University of Washington, Seattle, WA, USA

Susan L. Howard

Earth & Space Research, Seattle, WA, USA

Laurie Padman

Earth & Space Research, Corvallis, OR, USA

Matthew R. Siegfried

Hydrologic Sciences & Engineering Program, Department of Geophysics, Colorado School of Mines, Golden, CO, USA

Editor

Taher Chegini

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.7"
date-released: "2025-08-15"
keywords:
  - Ocean Tides
  - Load Tides
  - Pole Tides
  - Solid Earth Tides
  - Tidal Prediction
license: MIT

GitHub Events

Total

Create event: 48
Issues event: 14
Release event: 4
Watch event: 26
Delete event: 44
Issue comment event: 51
Push event: 234
Pull request review comment event: 1
Pull request review event: 7
Pull request event: 80
Fork event: 13

Last Year

Create event: 48
Issues event: 14
Release event: 4
Watch event: 26
Delete event: 44
Issue comment event: 51
Push event: 234
Pull request review comment event: 1
Pull request review event: 7
Pull request event: 80
Fork event: 13

Committers

Last synced: 7 months ago

All Time

Total Commits: 416
Total Committers: 6
Avg Commits per committer: 69.333
Development Distribution Score (DDS): 0.255

Past Year

Commits: 99
Committers: 4
Avg Commits per committer: 24.75
Development Distribution Score (DDS): 0.061

Top Committers

Name	Email	Commits
Tyler Sutterley	t**l@u**u	310
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

Committer Domains (Top 20 + Academic)

google.com: 1 nasa.gov: 1 ga.gov.au: 1 uw.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 30
Total pull requests: 197
Average time to close issues: 7 months
Average time to close pull requests: 4 days
Total issue authors: 19
Total pull request authors: 8
Average comments per issue: 2.37
Average comments per pull request: 0.75
Merged pull requests: 173
Bot issues: 0
Bot pull requests: 9

Past Year

Issues: 8
Pull requests: 97
Average time to close issues: 2 days
Average time to close pull requests: about 7 hours
Issue authors: 5
Pull request authors: 7
Average comments per issue: 0.5
Average comments per pull request: 0.7
Merged pull requests: 76
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

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

Pull Request Authors

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

Top Labels

Issue Labels

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

Pull Request Labels

bug (1)

Packages

Total packages: 2
Total downloads:
- pypi 7,467 last-month
Total docker downloads: 25

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 9
(may contain duplicates)
Total versions: 72
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
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.
Latest release: 2.2.7
published 6 months ago

Versions: 64
Dependent Packages: 0
Dependent Repositories: 7
Downloads: 7,467 Last month
Docker Downloads: 25

Rankings

Downloads: 5.5%

Dependent repos count: 5.6%

Average: 7.1%

Forks count: 7.1%

Stargazers count: 7.3%

Dependent packages count: 10.1%

Maintainers (1)

tsutterley

Last synced: 6 months ago

conda-forge.org: pytmd

Python-based tidal prediction software that reads OTIS, GOT and FES formatted tidal solutions for predicting ocean and load tides and can use IERS conventions for calculating radial pole tide displacements

Homepage: https://github.com/pyTMD/pyTMD
License: MIT
Latest release: 1.1.2
published over 3 years ago

Versions: 8
Dependent Packages: 0
Dependent Repositories: 2

Rankings

Dependent repos count: 20.2%

Average: 37.1%

Forks count: 38.0%

Stargazers count: 38.6%

Dependent packages count: 51.6%

Last synced: 6 months ago

Dependencies

.github/workflows/auto-update-bulletin-a.yml actions

actions/checkout v2 composite
conda-incubator/setup-miniconda v2 composite
peter-evans/create-pull-request v3 composite

.github/workflows/auto-update-files.yml actions

actions/checkout v2 composite
conda-incubator/setup-miniconda v2 composite
peter-evans/create-pull-request v3 composite

.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

.github/workflows/Dockerfile docker

python 3.9-slim-buster build

requirements-dev.txt pypi

boto3 * development
flake8 * development
numpy * development
oct2py * development
pytest >=4.6 development
pytest-cov * development

requirements.txt pypi

lxml *
netCDF4 *
numpy *
pyproj *
python-dateutil *
scipy >=1.10.1
setuptools_scm *

setup.py pypi

doc/environment.yml conda

docutils <0.18
fontconfig
freetype
graphviz
lxml
numpy
numpydoc
pip
python >=3.6
python-dateutil
pyyaml
scipy
setuptools_scm
sphinx
sphinx_rtd_theme

environment.yml pypi

pytmd

Science Score: 77.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

pyTMD

Installation

Running with Pixi

Dependencies

References

Download

Alternative Software

Disclaimer

Contributing

Credits

License

Owner

JOSS Publication

pyTMD: Python-based tidal prediction software

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: pytmd

Rankings

Maintainers (1)

conda-forge.org: pytmd

Rankings

Dependencies