=====================
Deltares Wave Toolbox
=====================
A Python toolbox for wave analysis
Features
--------
From a time series of water level elevations, the toolbox can calculate:
* the wave spectrum
* spectral wave parameters such as wave heigth and different wave periods
* wave height exceedance curves
* theoretical wave spectra and wave height distributions
* linear decomposition into incoming and reflected waves (using multiple wave gauges)
How to install the toolbox?
-----------------------------
The package is available at pip. To install the package run:
`pip install deltares-wave-toolbox`
Where to find information about the Deltares Wave Toolbox?
----------------------------------------------------------
See the online manual for information about the toolbox. In addition, the examples folder contains scripts with applications of the toolbox and a Jupyter notebook is available in the documentation folder.
Credits
-------
* Jan Kramer <jan.kramer@deltares.nl>
* Menno de Ridder <menno.deridder@deltares.nl>
* Ivo van der Werf <ivo.vanderwerf@deltares.nl>
* Joost den Bieman <joost.denbieman@deltares.nl>
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
1.1.0 (2024-XX-XX)
------------------
* "Rogue" release
* Python 3.9 support dropped (due to issues with scipy)
* Python 3.13 support added
* Added feature: wave decomposition into incoming and reflected waves (cores.core_wave_decomposition.decompose_linear_ZS_series)
* Added feature: calculate wave steepness and high or low-frequency wave parameters (Spectrum class)
1.0.0 (2023-10-27)
------------------
* Initial "Swell" release
Raw data
{
"_id": null,
"home_page": "https://github.com/Deltares-research/wave-toolbox",
"name": "deltares-wave-toolbox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "deltares_wave_toolbox",
"author": "Deltares",
"author_email": "joost.denbieman@deltares.nl",
"download_url": "https://files.pythonhosted.org/packages/2b/55/b3d52ec78900a57d771a5277a7622a3512b69f716dbf27e227545ee0e883/deltares_wave_toolbox-1.1.0.tar.gz",
"platform": null,
"description": "=====================\nDeltares Wave Toolbox\n=====================\n\n\n\n\n\n\nA Python toolbox for wave analysis\n\n\n\nFeatures\n--------\n\nFrom a time series of water level elevations, the toolbox can calculate:\n\n* the wave spectrum\n* spectral wave parameters such as wave heigth and different wave periods\n* wave height exceedance curves\n* theoretical wave spectra and wave height distributions\n* linear decomposition into incoming and reflected waves (using multiple wave gauges)\n\nHow to install the toolbox?\n-----------------------------\n\nThe package is available at pip. To install the package run:\n\n`pip install deltares-wave-toolbox`\n\nWhere to find information about the Deltares Wave Toolbox?\n----------------------------------------------------------\n\nSee the online manual for information about the toolbox. In addition, the examples folder contains scripts with applications of the toolbox and a Jupyter notebook is available in the documentation folder.\n\n\nCredits\n-------\n\n* Jan Kramer <jan.kramer@deltares.nl>\n* Menno de Ridder <menno.deridder@deltares.nl>\n* Ivo van der Werf <ivo.vanderwerf@deltares.nl>\n* Joost den Bieman <joost.denbieman@deltares.nl>\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n1.1.0 (2024-XX-XX)\n------------------\n\n* \"Rogue\" release\n* Python 3.9 support dropped (due to issues with scipy)\n* Python 3.13 support added\n* Added feature: wave decomposition into incoming and reflected waves (cores.core_wave_decomposition.decompose_linear_ZS_series)\n* Added feature: calculate wave steepness and high or low-frequency wave parameters (Spectrum class)\n\n1.0.0 (2023-10-27)\n------------------\n\n* Initial \"Swell\" release\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python toolbox for wave analysis",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/Deltares-research/wave-toolbox"
},
"split_keywords": [
"deltares_wave_toolbox"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa70994ed1bb7f34e69727477c3c08ff33c8c600d84b954390b8a635206303fc",
"md5": "aba43fa62fe1fab652e9760252e5d8a0",
"sha256": "28c0e0278866fff1f3df2c0b0648572ed3be6babbc3a297bd3aec13133edc8d5"
},
"downloads": -1,
"filename": "deltares_wave_toolbox-1.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "aba43fa62fe1fab652e9760252e5d8a0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 46706,
"upload_time": "2024-11-01T11:57:34",
"upload_time_iso_8601": "2024-11-01T11:57:34.843846Z",
"url": "https://files.pythonhosted.org/packages/aa/70/994ed1bb7f34e69727477c3c08ff33c8c600d84b954390b8a635206303fc/deltares_wave_toolbox-1.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b55b3d52ec78900a57d771a5277a7622a3512b69f716dbf27e227545ee0e883",
"md5": "06392b90eab0e6db88b1bde55964bbcf",
"sha256": "3030f61bb04b668be09d8823094387f45122f9179debbf50828f57a0ba5ad0c7"
},
"downloads": -1,
"filename": "deltares_wave_toolbox-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "06392b90eab0e6db88b1bde55964bbcf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 55802,
"upload_time": "2024-11-01T11:57:37",
"upload_time_iso_8601": "2024-11-01T11:57:37.047665Z",
"url": "https://files.pythonhosted.org/packages/2b/55/b3d52ec78900a57d771a5277a7622a3512b69f716dbf27e227545ee0e883/deltares_wave_toolbox-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 11:57:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Deltares-research",
"github_project": "wave-toolbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "deltares-wave-toolbox"
}
JSON
