Citation Information

References

This work was initially supported by an appointment to the NASA Postdoctoral Program (NPP) at NASA Goddard Space Flight Center (GSFC), administered by Universities Space Research Association (USRA) under contract with NASA. It is currently supported under the NASA Cryospheric Sciences Program (Grant Number 80NSSC22K0379). The programs included in this software have contributed most recently to the following work:

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

If you have used pyTMD in your work, please consider citing our library:

T. C. Sutterley, K. Alley, K. Brunt, S. Howard, L. Padman, and M. Siegfried, “pyTMD: Python-based tidal prediction software”, (2017). doi: 10.5281/zenodo.5555395

Contributors

• Karen Alley (University of Manitoba)

• Kelly Brunt (NASA Goddard Space Flight Center)

• Susan Howard (Earth & Space Research)

• Laurie Padman (Earth & Space Research)

• Matt Siegfried (Colorado School of Mines)

• Tyler Sutterley (University of Washington)

Development

pyTMD is an open source project. We welcome any help in maintaining and developing the software and documentation. Anyone at any career stage and with any level of coding experience can contribute. Please see the Contribution Guidelines for more information.

Problem Reports

If you have found a problem in pyTMD, or you would like to suggest an improvement or modification, please submit a GitHub issue and we will get back to you.

Dependencies

This software is also dependent on other commonly used Python packages:

• 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

Optional Dependencies

• cartopy: Python package designed for geospatial data processing

• gdal: Pythonic interface to the Geospatial Data Abstraction Library (GDAL)

• h5py: Python interface for Hierarchal Data Format 5 (HDF5)

• ipyleaflet: Jupyter / Leaflet bridge enabling interactive maps

• ipywidgets: interactive HTML widgets for Jupyter notebooks and IPython

• jplephem: Python implementation of the math for predicting raw (x,y,z) planetary positions from JPL ephemerides

• matplotlib: Python 2D plotting library

• pandas: Python Data Analysis Library

• PyYAML: YAML parser and emitter for Python

Credits

The Tidal Model Driver (TMD) Matlab Toolbox was developed by Laurie Padman, Lana Erofeeva and Susan Howard. 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.

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. Outputs from this software should be used for scientific or technical purposes only. This software should not be used for coastal navigation or any application that may risk life or property.