| Name | pyTMD JSON |
| Version |
2.2.8
JSON |
| download |
| home_page | None |
| Summary | Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides |
| upload_time | 2025-09-05 23:07:33 |
| maintainer | pyTMD contributors |
| docs_url | None |
| author | Tyler Sutterley |
| requires_python | ~=3.6 |
| 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.
|
| keywords |
ocean tides
load tides
pole tides
solid earth tides
tidal prediction
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyTMD
[](https://github.com/pyTMD/pyTMD/blob/main/LICENSE)
[](https://pytmd.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.python.org/pypi/pyTMD/)
[](https://anaconda.org/conda-forge/pytmd)
[](https://github.com/pyTMD/pyTMD/releases/latest)
[](https://doi.org/10.5281/zenodo.5555395)
Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides
For more information: see the documentation at [pytmd.readthedocs.io](https://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](https://pixi.sh/) for a streamlined workspace environment:
1. Install Pixi following the [installation instructions](https://pixi.sh/latest/#installation)
2. Clone the project repository:
```bash
git clone https://github.com/pyTMD/pyTMD.git
```
3. Move into the `pyTMD` directory
```bash
cd pyTMD
```
4. Install dependencies and start JupyterLab:
```bash
pixi run start
```
This will automatically create the environment, install all dependencies, and launch JupyterLab in the [notebooks](./doc/source/notebooks/) directory.
## Dependencies
- [dateutil: powerful extensions to datetime](https://dateutil.readthedocs.io/en/stable/)
- [lxml: processing XML and HTML in Python](https://pypi.python.org/pypi/lxml)
- [netCDF4: Python interface to the netCDF C library](https://unidata.github.io/netcdf4-python/)
- [numpy: Scientific Computing Tools For Python](https://www.numpy.org)
- [pyproj: Python interface to PROJ library](https://pypi.org/project/pyproj/)
- [scipy: Scientific Tools for Python](https://www.scipy.org/)
- [timescale: Python tools for time and astronomical calculations](https://pypi.org/project/timescale/)
## 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](https://doi.org/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](https://doi.org/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](./CONTRIBUTORS.rst).
If you would like to contribute to the project, please have a look at the [contribution guidelines](./doc/source/getting_started/Contributing.rst), [open issues](https://github.com/pyTMD/pyTMD/issues) and [discussions board](https://github.com/pyTMD/pyTMD/discussions).
## Credits
The Tidal Model Driver ([TMD](https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5)) Matlab Toolbox was developed by Laurie Padman, Lana Erofeeva and Susan Howard.
An updated version of the TMD Matlab Toolbox ([TMD3](https://github.com/chadagreene/Tide-Model-Driver)) was developed by Chad Greene.
The OSU Tidal Inversion Software (OTIS) and OSU Tidal Prediction Software ([OTPS](https://www.tpxo.net/otps)) were developed by Lana Erofeeva and Gary Egbert ([copyright OSU](https://www.tpxo.net/tpxo-products-and-registration), 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](https://codeberg.org/rray/perth5)) was developed by Richard Ray.
## License
The content of this project is licensed under the [Creative Commons Attribution 4.0 Attribution license](https://creativecommons.org/licenses/by/4.0/) and the source code is licensed under the [MIT license](LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "pyTMD",
"maintainer": "pyTMD contributors",
"docs_url": null,
"requires_python": "~=3.6",
"maintainer_email": null,
"keywords": "Ocean Tides, Load Tides, Pole Tides, Solid Earth Tides, Tidal Prediction",
"author": "Tyler Sutterley",
"author_email": "tsutterl@uw.edu",
"download_url": "https://files.pythonhosted.org/packages/9a/ba/2ce7d041532ca04a15ded0603b6f13c41575cc1cc31216aad63d1c34bbd9/pytmd-2.2.8.tar.gz",
"platform": null,
"description": "# pyTMD\n\n[](https://github.com/pyTMD/pyTMD/blob/main/LICENSE)\n[](https://pytmd.readthedocs.io/en/latest/?badge=latest)\n[](https://pypi.python.org/pypi/pyTMD/)\n[](https://anaconda.org/conda-forge/pytmd)\n[](https://github.com/pyTMD/pyTMD/releases/latest)\n[](https://doi.org/10.5281/zenodo.5555395)\n\nPython-based tidal prediction software for estimating ocean, load, solid Earth and pole tides\n\nFor more information: see the documentation at [pytmd.readthedocs.io](https://pytmd.readthedocs.io/)\n\n## Installation\n\nFrom PyPI:\n\n```bash\npython3 -m pip install pyTMD\n```\n\nTo include all optional dependencies:\n\n```bash\npython3 -m pip install pyTMD[all]\n```\n\nUsing `conda` or `mamba` from conda-forge:\n\n```bash\nconda install -c conda-forge pytmd\n```\n\n```bash\nmamba install -c conda-forge pytmd\n```\n\nDevelopment version from GitHub:\n\n```bash\npython3 -m pip install git+https://github.com/pyTMD/pyTMD.git\n```\n\n### Running with Pixi\n\nAlternatively, you can use [Pixi](https://pixi.sh/) for a streamlined workspace environment:\n\n1. Install Pixi following the [installation instructions](https://pixi.sh/latest/#installation)\n2. Clone the project repository:\n\n```bash\ngit clone https://github.com/pyTMD/pyTMD.git\n```\n\n3. Move into the `pyTMD` directory\n\n```bash\ncd pyTMD\n```\n\n4. Install dependencies and start JupyterLab:\n\n```bash\npixi run start\n```\n\nThis will automatically create the environment, install all dependencies, and launch JupyterLab in the [notebooks](./doc/source/notebooks/) directory.\n\n## Dependencies\n\n- [dateutil: powerful extensions to datetime](https://dateutil.readthedocs.io/en/stable/)\n- [lxml: processing XML and HTML in Python](https://pypi.python.org/pypi/lxml)\n- [netCDF4: Python interface to the netCDF C library](https://unidata.github.io/netcdf4-python/)\n- [numpy: Scientific Computing Tools For Python](https://www.numpy.org)\n- [pyproj: Python interface to PROJ library](https://pypi.org/project/pyproj/)\n- [scipy: Scientific Tools for Python](https://www.scipy.org/)\n- [timescale: Python tools for time and astronomical calculations](https://pypi.org/project/timescale/)\n\n## References\n\n> T. C. Sutterley, T. Markus, T. A. Neumann, M. R. van den Broeke, J. M. van Wessem, and S. R. M. Ligtenberg,\n> \"Antarctic ice shelf thickness change from multimission lidar mapping\", *The Cryosphere*,\n> 13, 1801-1817, (2019). [doi: 10.5194/tc-13-1801-2019](https://doi.org/10.5194/tc-13-1801-2019)\n>\n> L. Padman, M. R. Siegfried, H. A. Fricker,\n> \"Ocean Tide Influences on the Antarctic and Greenland Ice Sheets\", *Reviews of Geophysics*,\n> 56, 142-184, (2018). [doi: 10.1002/2016RG000546](https://doi.org/10.1002/2016RG000546)\n\n## Download\n\nThe program homepage is: \n<https://github.com/pyTMD/pyTMD>\n\nA zip archive of the latest version is available directly at: \n<https://github.com/pyTMD/pyTMD/archive/main.zip>\n\n## Alternative Software\n\nperth5 from NASA Goddard Space Flight Center: \n<https://codeberg.org/rray/perth5>\n\nMatlab Tide Model Driver from Earth & Space Research: \n<https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5>\n\nFortran OSU Tidal Prediction Software: \n<https://www.tpxo.net/otps>\n\n## Disclaimer\n\nThis package includes software developed at NASA Goddard Space Flight Center (GSFC) and the University of Washington Applied Physics Laboratory (UW-APL).\nIt is not sponsored or maintained by the Universities Space Research Association (USRA), AVISO or NASA.\nThe software is provided here for your convenience but *with no guarantees whatsoever*.\nIt should not be used for coastal navigation or any application that may risk life or property.\n\n## Contributing\n\nThis project contains work and contributions from the [scientific community](./CONTRIBUTORS.rst).\nIf you would like to contribute to the project, please have a look at the [contribution guidelines](./doc/source/getting_started/Contributing.rst), [open issues](https://github.com/pyTMD/pyTMD/issues) and [discussions board](https://github.com/pyTMD/pyTMD/discussions).\n\n## Credits\n\nThe Tidal Model Driver ([TMD](https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5)) Matlab Toolbox was developed by Laurie Padman, Lana Erofeeva and Susan Howard.\nAn updated version of the TMD Matlab Toolbox ([TMD3](https://github.com/chadagreene/Tide-Model-Driver)) was developed by Chad Greene.\nThe OSU Tidal Inversion Software (OTIS) and OSU Tidal Prediction Software ([OTPS](https://www.tpxo.net/otps)) were developed by Lana Erofeeva and Gary Egbert ([copyright OSU](https://www.tpxo.net/tpxo-products-and-registration), licensed for non-commercial use).\nThe NASA Goddard Space Flight Center (GSFC) PREdict Tidal Heights (PERTH3) software was developed by Richard Ray and Remko Scharroo.\nAn updated and more versatile version of the NASA GSFC tidal prediction software ([PERTH5](https://codeberg.org/rray/perth5)) was developed by Richard Ray.\n\n## License\n\nThe content of this project is licensed under the [Creative Commons Attribution 4.0 Attribution license](https://creativecommons.org/licenses/by/4.0/) and the source code is licensed under the [MIT license](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2017 Tyler C Sutterley\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides",
"version": "2.2.8",
"project_urls": {
"Documentation": "https://pytmd.readthedocs.io",
"Homepage": "https://pytmd.readthedocs.io",
"Issues": "https://github.com/pyTMD/pyTMD/issues",
"Repository": "https://github.com/pyTMD/pyTMD"
},
"split_keywords": [
"ocean tides",
" load tides",
" pole tides",
" solid earth tides",
" tidal prediction"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c6045eea21dcc88fe5c579d0f411f92f23a27728464fd042acaa597ae5540c12",
"md5": "0bb6c885d604eeb78747971de71668bc",
"sha256": "e8eb60206cf739c5028bcfe3b627ea93b773da28f094ecc93e3f47e8cd605d1a"
},
"downloads": -1,
"filename": "pytmd-2.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bb6c885d604eeb78747971de71668bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.6",
"size": 6545173,
"upload_time": "2025-09-05T23:07:31",
"upload_time_iso_8601": "2025-09-05T23:07:31.748549Z",
"url": "https://files.pythonhosted.org/packages/c6/04/5eea21dcc88fe5c579d0f411f92f23a27728464fd042acaa597ae5540c12/pytmd-2.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9aba2ce7d041532ca04a15ded0603b6f13c41575cc1cc31216aad63d1c34bbd9",
"md5": "f550334e0bc06a1f1b3045410628c8cb",
"sha256": "b384881056a3730c01ccfde50d628474ba69d5fa399733e6ebee7e80c34ffd42"
},
"downloads": -1,
"filename": "pytmd-2.2.8.tar.gz",
"has_sig": false,
"md5_digest": "f550334e0bc06a1f1b3045410628c8cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.6",
"size": 6517357,
"upload_time": "2025-09-05T23:07:33",
"upload_time_iso_8601": "2025-09-05T23:07:33.699100Z",
"url": "https://files.pythonhosted.org/packages/9a/ba/2ce7d041532ca04a15ded0603b6f13c41575cc1cc31216aad63d1c34bbd9/pytmd-2.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-05 23:07:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyTMD",
"github_project": "pyTMD",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pytmd"
}
