| Name | pyTMD JSON |
| Version |
2.2.0
JSON |
| download |
| home_page | None |
| Summary | Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides |
| upload_time | 2024-12-20 19:12:34 |
| 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
=====
|License|
|Documentation Status|
|Coverage Status|
|PyPI|
|conda-forge|
|zenodo|
.. |License| image:: https://img.shields.io/github/license/tsutterley/pyTMD
:target: https://github.com/tsutterley/pyTMD/blob/main/LICENSE
.. |Documentation Status| image:: https://readthedocs.org/projects/pytmd/badge/?version=latest
:target: https://pytmd.readthedocs.io/en/latest/?badge=latest
.. |Coverage Status| image:: https://codecov.io/gh/tsutterley/pyTMD/branch/main/graph/badge.svg
:target: https://codecov.io/gh/tsutterley/pyTMD
.. |PyPI| image:: https://img.shields.io/pypi/v/pyTMD.svg
:target: https://pypi.python.org/pypi/pyTMD/
.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pytmd
:target: https://anaconda.org/conda-forge/pytmd
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5555395.svg
:target: 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:
.. code-block:: bash
python3 -m pip install pyTMD
To include all optional dependencies:
.. code-block:: bash
python3 -m pip install pyTMD[all]
Using `conda` or `mamba` from conda-forge:
.. code-block:: bash
conda install -c conda-forge pytmd
.. code-block:: bash
mamba install -c conda-forge pytmd
Development version from GitHub:
.. code-block:: bash
python3 -m pip install git+https://github.com/tsutterley/pyTMD.git
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/>`_
- `setuptools_scm: manager for python package versions using scm metadata <https://pypi.org/project/setuptools-scm>`_
- `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/tsutterley/pyTMD
| A zip archive of the latest version is available directly at:
| https://github.com/tsutterley/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 `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and the project `code of conduct <./CODE_OF_CONDUCT.rst>`_.
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/89/4d/a9984a6e590961c631289be0b05a7336ec0aafb390493b0b378143ad04ef/pytmd-2.2.0.tar.gz",
"platform": null,
"description": "=====\npyTMD\n=====\n\n|License|\n|Documentation Status|\n|Coverage Status|\n|PyPI|\n|conda-forge|\n|zenodo|\n\n.. |License| image:: https://img.shields.io/github/license/tsutterley/pyTMD\n :target: https://github.com/tsutterley/pyTMD/blob/main/LICENSE\n\n.. |Documentation Status| image:: https://readthedocs.org/projects/pytmd/badge/?version=latest\n :target: https://pytmd.readthedocs.io/en/latest/?badge=latest\n\n.. |Coverage Status| image:: https://codecov.io/gh/tsutterley/pyTMD/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/tsutterley/pyTMD\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/pyTMD.svg\n :target: https://pypi.python.org/pypi/pyTMD/\n\n.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pytmd\n :target: https://anaconda.org/conda-forge/pytmd\n\n.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5555395.svg\n :target: 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\nInstallation\n############\n\nFrom PyPI:\n\n.. code-block:: bash\n\n python3 -m pip install pyTMD\n\nTo include all optional dependencies:\n\n.. code-block:: bash\n\n python3 -m pip install pyTMD[all]\n\nUsing `conda` or `mamba` from conda-forge:\n\n.. code-block:: bash\n\n conda install -c conda-forge pytmd\n\n.. code-block:: bash\n\n mamba install -c conda-forge pytmd\n\nDevelopment version from GitHub:\n\n.. code-block:: bash\n\n python3 -m pip install git+https://github.com/tsutterley/pyTMD.git\n\nDependencies\n############\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- `setuptools_scm: manager for python package versions using scm metadata <https://pypi.org/project/setuptools-scm>`_\n- `timescale: Python tools for time and astronomical calculations <https://pypi.org/project/timescale/>`_\n\nReferences\n##########\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\nDownload\n########\n\n| The program homepage is:\n| https://github.com/tsutterley/pyTMD\n| A zip archive of the latest version is available directly at:\n| https://github.com/tsutterley/pyTMD/archive/main.zip\n\nAlternative Software\n####################\n\n| perth5 from NASA Goddard Space Flight Center:\n| https://codeberg.org/rray/perth5\n| Matlab Tide Model Driver from Earth & Space Research:\n| https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5\n| Fortran OSU Tidal Prediction Software:\n| https://www.tpxo.net/otps\n\nDisclaimer\n##########\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\nContributing\n############\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 `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and the project `code of conduct <./CODE_OF_CONDUCT.rst>`_.\n\nCredits\n#######\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\nLicense\n#######\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 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. ",
"summary": "Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides",
"version": "2.2.0",
"project_urls": {
"Documentation": "https://pytmd.readthedocs.io",
"Homepage": "https://pytmd.readthedocs.io",
"Issues": "https://github.com/tsutterley/pyTMD/issues",
"Repository": "https://github.com/tsutterley/pyTMD"
},
"split_keywords": [
"ocean tides",
" load tides",
" pole tides",
" solid earth tides",
" tidal prediction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "038f48d5b64a0c6555becc89e76f3be5985e645dde754432d99848d9899f878c",
"md5": "daf6d34a2a223836c53733b06f39ad47",
"sha256": "7f727a138a9b7028ca12e033e99f406688ab9f013e6e9f7a78bff48d4393c184"
},
"downloads": -1,
"filename": "pyTMD-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "daf6d34a2a223836c53733b06f39ad47",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.6",
"size": 6456124,
"upload_time": "2024-12-20T19:12:31",
"upload_time_iso_8601": "2024-12-20T19:12:31.952321Z",
"url": "https://files.pythonhosted.org/packages/03/8f/48d5b64a0c6555becc89e76f3be5985e645dde754432d99848d9899f878c/pyTMD-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "894da9984a6e590961c631289be0b05a7336ec0aafb390493b0b378143ad04ef",
"md5": "395c4219113b3479b77b5232e463fb4f",
"sha256": "b18aba6d2d78e69a17b3cf1937acc5524e8795af250e29585c920a5443c4af7d"
},
"downloads": -1,
"filename": "pytmd-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "395c4219113b3479b77b5232e463fb4f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.6",
"size": 6354754,
"upload_time": "2024-12-20T19:12:34",
"upload_time_iso_8601": "2024-12-20T19:12:34.063261Z",
"url": "https://files.pythonhosted.org/packages/89/4d/a9984a6e590961c631289be0b05a7336ec0aafb390493b0b378143ad04ef/pytmd-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 19:12:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tsutterley",
"github_project": "pyTMD",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pytmd"
}
