pyTMD Documentation

Welcome to the documentation for pyTMD, a Python-based tidal prediction software. This documentation is intended to explain how to compute ocean, solid Earth, load and pole tide variations using the set of pyTMD programs.

Note

If you have previously used pyTMD, check out the Transition Guide for v3 for information on changes incorporated in Version 3.

Introduction

Installation

./getting_started/Install.html

Getting Started

./getting_started/Getting-Started.html

User Guide

API Reference

./api_reference/API-Reference.html

Background

./background/Background.html

Examples

./user_guide/Examples.html

Troubleshooting

./user_guide/Troubleshooting.html

Contribute

Guidelines

./getting_started/Contributing.html

Code of Conduct

./getting_started/Code-of-Conduct.html

Discussions

https://github.com/pyTMD/pyTMD/discussions

Issues

https://github.com/pyTMD/pyTMD/issues

Project Details

Release Notes

./release_notes/Release-Notes.html

Contributors

./project/Contributors.html

License

./project/Licenses.html

Citation Information

./project/Citations.html