Skip to main content

PyGTide

DOI

PyGTide is a Python module that computes gravitational tides on Earth. It wraps ETERNA PREDICT 3.4 — the classic Fortran 77/90 code by the late Prof. H.-G. Wenzel (Wenzel, 1996), updated with the KSM03 tidal catalogue by Kudryavtsev (2004) — compiled into a Python extension using f2py. The original Fortran code was comprehensively revised for the Python integration, and significant bugs were identified and repaired (see the CHANGELOG).

Key features

  • Computes 11 tidal components: tidal potential, gravity, tilt, vertical/horizontal displacement, and vertical/horizontal/areal/shear/volume strain
  • Choice of 8 tidal potential catalogues, up to Kudryavtsev KSM03 with 28,806 waves (~0.025 nGal accuracy)
  • Pole-tide and length-of-day (LOD) corrections based on IERS Earth orientation data
  • Results returned as a time-stamped pandas DataFrame in UTC
  • Fast f2py-compiled Fortran core with a convenient Python class interface
  • Pre-compiled wheels for Linux, macOS and Windows — no Fortran compiler required

Documentation

Document Contents
Installation Prerequisites and step-by-step setup
Quickstart The fastest way to a first result
Usage Guide Core features, class API and worked examples
Configuration All parameters, keywords and data files
Background Earth tides, time scales, catalogues and output conventions
Troubleshooting Common errors, FAQs and solutions

Quick install and first run

pip install pygtide
from pygtide import predict_series

# latitude, longitude, height, startdate, duration [h], samprate [s]
args = (49.00937, 8.40444, 120, '2018-01-01', 24 * 7, 3600)
series = predict_series(*args)

[!IMPORTANT] By default, gravity, potential and tilt outputs are rigid-Earth (geometric) tides, while displacement and strain outputs are body tides (Love numbers applied). Read Background — Absolute scale of the output before interpreting amplitudes.

Example

This image shows Earth tides calculated for the city Karlsruhe (Germany) in the year 2018.

How to cite

If you use PyGTide, please cite the work as:

Rau, Gabriel C. (2018) hydrogeoscience/pygtide: PyGTide. Zenodo. https://doi.org/10.5281/zenodo.1346260

References

  • Hartmann, T., and H.-G. Wenzel (1995), The HW95 tidal potential catalogue, Geophysical Research Letters, 22(24), 3553–3556, https://doi.org/10.1029/95GL03324.
  • Kudryavtsev, S. M. (2004), Improved harmonic development of the Earth tide-generating potential, Journal of Geodesy, 77(12), 829–838, https://doi.org/10.1007/s00190-003-0361-2.
  • Wenzel, H.-G. (1996), The nanogal software: Earth tide data processing package ETERNA 3.30, Bulletin d'Informations des Marées Terrestres, 124, 9425–9439.
  • McMillan, T. C., Rau, G. C., Timms, W. A., and Andersen, M. S. (2019), Utilizing the impact of Earth and atmospheric tides on groundwater systems: A review reveals the future potential, Reviews of Geophysics, https://dx.doi.org/10.1029/2018RG000630.

License

PyGTide is released by Gabriel C. Rau, Tom Eulenfeld and Craig Miller under the Mozilla Public License 2.0.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygtide-0.9.1.tar.gz (3.1 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

pygtide-0.9.1-cp314-cp314-win_amd64.whl (4.8 MB view details)

Uploaded CPython 3.14Windows x86-64

pygtide-0.9.1-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (4.3 MB view details)

Uploaded CPython 3.14manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

pygtide-0.9.1-cp314-cp314-macosx_15_0_arm64.whl (3.4 MB view details)

Uploaded CPython 3.14macOS 15.0+ ARM64

pygtide-0.9.1-cp313-cp313-win_amd64.whl (4.7 MB view details)

Uploaded CPython 3.13Windows x86-64

pygtide-0.9.1-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (4.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

pygtide-0.9.1-cp313-cp313-macosx_15_0_arm64.whl (3.4 MB view details)

Uploaded CPython 3.13macOS 15.0+ ARM64

pygtide-0.9.1-cp312-cp312-win_amd64.whl (4.7 MB view details)

Uploaded CPython 3.12Windows x86-64

pygtide-0.9.1-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (4.3 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

pygtide-0.9.1-cp312-cp312-macosx_15_0_arm64.whl (3.4 MB view details)

Uploaded CPython 3.12macOS 15.0+ ARM64

File details

Details for the file pygtide-0.9.1.tar.gz.

File metadata

  • Download URL: pygtide-0.9.1.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pygtide-0.9.1.tar.gz
Algorithm Hash digest
SHA256 23e385dce3ccba62891322ffc497c9bb124f6d0a2a227525c757377a794d6a63
MD5 c997534c349407113f432ff8081c6686
BLAKE2b-256 97319fd5c6870169e5c6a35edb2584b46c863ecd41761c0f9ef21ea657517e09

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp314-cp314-win_amd64.whl.

File metadata

  • Download URL: pygtide-0.9.1-cp314-cp314-win_amd64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: CPython 3.14, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pygtide-0.9.1-cp314-cp314-win_amd64.whl
Algorithm Hash digest
SHA256 622d95fdd1061eb43666f5eb736739c8aa408af48b95388a1ab67dd08f24283d
MD5 673a7a2bcdd1c48f298e79214ee02395
BLAKE2b-256 875885539f618aacb09cc67ee0e093063331cee3e3b0d6f35b17281bf3a229e3

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pygtide-0.9.1-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 6bf4956838715bfef13da75923585b8079383d4af9168db060f374b2df9945f0
MD5 8203ccce7f88a2bf3308e78744e04b16
BLAKE2b-256 763e8f60da6d41af7089ef0c92dd13a3a250fab554e45ca922109628d268452e

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp314-cp314-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for pygtide-0.9.1-cp314-cp314-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 9a99f526f0f53b476a6fc8b4ed0b4a283725010c3ffb6780985e3ef32c9c878a
MD5 309e78e493f2ab740a69194412abd483
BLAKE2b-256 06f54ba2b52c9f7fe03b96f4804353812950651f64d6d2a188f212c8f1b85dc3

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: pygtide-0.9.1-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 4.7 MB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pygtide-0.9.1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 9e401e10af12449ab92783a508c79833247b4d85bdcd32f0058d44c40e8cdb9c
MD5 2cb138240e0fc4ca0a8a3c86cea7f2de
BLAKE2b-256 17010fb61b8dc97099ac960f0055c334b630d57064d938f9ae7b79c53c379ded

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pygtide-0.9.1-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 078039db516407a6ddb561cae0e38e77e4d4c3bcd68d3244f81ffa7d2424356f
MD5 3a941a9e60f0174e1b90560c00380e47
BLAKE2b-256 5071be8b0ff37f955639f38bf13a7e073fe490571bf9c4608466d5fe3c975412

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp313-cp313-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for pygtide-0.9.1-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 378b89c09c6c35a58e7fe149a5d4ec12f0b5833a87b6b3dc918407c902680389
MD5 71ca774f8683b947fd5af1ad85ac843d
BLAKE2b-256 b1e6511e0af5909ff5bb11035566ecc889097c5ae7b1d7a79ed448b5394510e8

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: pygtide-0.9.1-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 4.7 MB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pygtide-0.9.1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 ffebb52c775e235778364e3c0548d4065432a9b9861edcf73b02cd7003628b16
MD5 dbe7788b7430f6b56104fe673ae995c2
BLAKE2b-256 7e8a9d77c7bbcc2ec427437ff713192e0b784f9f4b0067f0b2ac54c77eb75e7e

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pygtide-0.9.1-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 420cded61ab77c07afff54a662ab04bc1ca35dfac312c9379394c25b687f2a67
MD5 3b3c95bba7bd11e236bf48e3e6f9fafb
BLAKE2b-256 7fc02752b6d2883e7e48de195998a77434b1b9473f350a3a51e1bb8c39660512

See more details on using hashes here.

File details

Details for the file pygtide-0.9.1-cp312-cp312-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for pygtide-0.9.1-cp312-cp312-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 67fc41098da395f4175ef0d7900c9004dc406e01e069794d6530680256750b52
MD5 d3195da73af29e52f945702f964902c8
BLAKE2b-256 b67d69a5e87848daeeec646ac99349a15a90c5d56ecb234cefc0c50f54bf7521

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.9.1 This release

10 files

0.9.0

10 files

0.8.2

10 files

0.8.1

1 file

0.8.0

1 file

0.7.1

1 file

0.7.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page