Logo

Getting Started

  • Setup and Installation
  • Getting Started
  • Background
  • Contribution Guidelines
  • Code of Conduct
  • Resources

User Guide

  • Examples
    • Compare NOAA Tides
    • Extrapolation Methods
    • Gap Fill Tide Map
    • Plot Antarctic Co-tidal Charts
    • Plot Arctic Ocean Map
    • Plot ATLAS Compact
    • Plot Ocean Pole Tide Map
    • Plot Solid Earth Tides
    • Plot TICON Stations
    • Plot Tide Forecasts
    • Plot Tide Form Factor
    • Plot Tide Range
    • Solve Synthetic Tides
  • Recipes

API Reference

  • astro
  • compute
  • constituents
  • datasets
  • earth
  • ellipse
  • interpolate
  • io
  • math
  • predict
  • solve
  • spatial
  • utilities

Project Details

  • Contributors
  • Licenses
  • Testing
  • Citation Information

Release Notes

  • Release Notes

Bibliography

  • Bibliography

External links

  • Source Code
  • License
  • Discussions
pyTMD
  • Examples
  • Edit on GitHub

Examples

Important

Running the example notebooks requires a full installation to include all of the optional dependencies.

Some notebooks require first downloading a tide model [see details on data access].

Compare NOAA Tides
Compares measurements from NOAA tide gauges with predicted values
Gap Fill Tide Map
Demonstrates gap filling in tide model data
Plot Antarctic Cotidal Charts
Plots cotidal charts for selected constituents around Antarctica
Plot Arctic Ocean Map
Creates an animation of hourly tidal elevations for the Arctic Ocean
Plot ATLAS Compact
Plots the global and local solutions from an ATLAS compact model
Plot Ocean Pole Tide Map
Plots maps of the real and imaginary geocentric pole tide admittance functions
Plot Solid Earth Tides
Creates a global animation of hourly solid Earth tides
Plot TICON Stations
Plots a forecast of tide heights using constituents from the TICON-4 database :cite:p:`HartDavis:2025gf`
Plot Tide Forecasts
Plots a weekly forecast of tidal displacements at a given location
Plot Tide Form Factor
Plots maps of the dominant tidal species
Plot Tide Range
Plots maps of the peak-to-peak range of tide heights
Solve Synthetic Tides
Solves for the amplitude and phase of harmonic constituents at a given location

Tip

More examples can be found on the Recipes page and in the Tutorials repository!

Previous Next

© Copyright 2017–2026, Tyler C. Sutterley.

Built with Sphinx using a theme provided by Read the Docs.