.. image:: https://github.com/timcera/tappy/actions/workflows/python-package.yml/badge.svg
:alt: Tests
:target: https://github.com/timcera/tappy/actions/workflows/python-package.yml
:height: 20
.. image:: https://img.shields.io/coveralls/github/timcera/tappy
:alt: Test Coverage
:target: https://coveralls.io/r/timcera/tappy?branch=master
:height: 20
.. image:: https://img.shields.io/pypi/v/tappy.svg
:alt: Latest release
:target: https://pypi.python.org/pypi/tappy/
:height: 20
.. image:: https://img.shields.io/pypi/l/tappy.svg
:alt: BSD-3 clause license
:target: https://pypi.python.org/pypi/tappy/
:height: 20
.. image:: https://img.shields.io/pypi/dd/tappy.svg
:alt: tappy downloads
:target: https://pypi.python.org/pypi/tappy/
:height: 20
.. image:: https://img.shields.io/pypi/pyversions/tappy
:alt: PyPI - Python Version
:target: https://pypi.org/project/tappy/
:height: 20
TAPPY is a tidal analysis package. It breaks down a record of water
levels into the component sine waves. It is written in Python and uses
the least squares optimization and other functions in
`SciPy <http://www.scipy.org>`__. The focus is to make the most accurate
analysis possible. TAPPY only determines the constituents that are
calculable according to the length of the time series.
Features
--------
- Outputs a ‘International Hydrographic Organization - Tidal and Water
Level Working Group’ standard XML constituent file.
- Uses the IHO standard XML constituent file to make a predicted time
series. By far the most frequent request that I get.
- Calculates the node factor at each water elevation measurement. Very
important for long time-series (greater than a year).
- Very accurate ephemeris calculations thanks to the
`Astrolabe <http://astrolabe.sourceforge.net>`__ library.
- Able to read in different input data sets without changing TAPPY or
the input data set. All you have to do is create a file that defines
the input data set. Thanks to
`Pyparsing <http://pyparsing.wikispaces.com/>`__.
- Added the capability to read compressed files and Internet data
streams (actually any URL) directly into TAPPY by using
`filelike <http://www.rfk.id.au/software/filelike/>`__.
- The time-series does not need to have equal intervals. In fact any
length of missing data is allowed (though too much missing will cause
a poor analysis).
- Can adjust the Rayleigh factor that nearby constituents are compared
against to determine what constituents can be differentiated.
- TAPPY chooses the main constituents based upon the length of the time
series and infers additional constituents that are known to be
specifically related to the main constituents.
- Can filter the tidal energy out of the input signal using transform
(FFT), usgs (PL33), doodson, and boxcar methods. \|
[CompareTidalFilters]
- Can use the tidal filters to zero the time-series before
determination of tidal constituents.
- Can pad the usgs, doodson, and boxcar filters with predicted data to
minimize edge effects of the filters.
- Convenience function to fill missing values with the predicted time series
Requirements
------------
`Python version 3.7.1 or later <http://www.python.org>`__
`SciPy <http://www.scipy.org>`__
Install
-------
::
# To install...
pip install tappy
TAPPY Citations
---------------
Akmal, P. N. E., (2013). Determination of the Permeability of
the South Chamorro Seamount in Mariana Forearc Crust Using
Pressure Response to Tidal Loading Method. University of
Miami. https://scholarship.miami.edu/esploro/outputs/991031448068902976
Barbosa, S. M., (2009). Analysis of trends in North Atlantic tidal
amplitudes University of Porto, Portugal (susana.barbosa@fc.up.pt)
http://meetingorganizer.copernicus.org/EGU2009/EGU2009-5154.pdf
Bechet, V., Verstraeten, E., Hanert, E. & Deleersnijder, E.,
(2018). Multiple-year marine connectivity modeling in the Florida Coral
Reef Tract to assess Acropora Cervicornis recovery. (Unpublished master’s
thesis). Ecole polytechnique de Louvain, Université catholique de Louvain.
Becker, K., Davis, E. E., & Villinger, H. (2022). Long‐Term Observations
of Subseafloor Temperatures and Pressures in a Low‐Temperature,
Off‐Axis Hydrothermal System in North Pond on the Western Flank
of the Mid‐Atlantic Ridge. Geochemistry, Geophysics, Geosystems,
23(9). Portico. https://doi.org/10.1029/2022gc010496
Billings, W. Z., (2018). An Exploration of the Two-Dimensional Poroelastic
Properties of Oceanic Crust at the Formation Scale. University of
Miami ProQuest Dissertations Publishing, 10846298.
Campos, E. J. D., Kjerfve, B., Cavalcante, G., Vieira, F., & Abouleish,
M. (2022). Water exchange across the Strait of Hormuz. Effects of
tides and rivers runoff. Regional Studies in Marine Science, 52,
102336. https://doi.org/10.1016/j.rsma.2022.102336
Cucco, A., Martín, J., Quattrocchi, G., Fenco, H., Umgiesser, G., &
Fernández, D. A. (2022). Water Circulation and Transport Time Scales in
the Beagle Channel, Southernmost Tip of South America. Journal of Marine
Science and Engineering, 10(7), 941. https://doi.org/10.3390/jmse10070941
Desmet, N., (2019). Modelling coral larvae exchanges between the Great
Barrier Reef and outer reefs. Ecole polytechnique de Louvain, Université
catholique de Louvain. Prom. : Hanert, Emmanuel ; Deleersnijder,
Eric. http://hdl.handle.net/2078.1/thesis:19591
Ferrarin, C., Roland, A., Bajo, M., Umgiesser, G., Cucco, A., Davolio, S.,
Buzzi, A., Malguzzi, P., & Drofa, O. (2013). Tide-surge-wave modelling and
forecasting in the Mediterranean Sea with focus on the Italian coast. Ocean
Modelling, 61, 38–48. https://doi.org/10.1016/j.ocemod.2012.10.003
Ferrarin, C., Zaggia, L., Paschini, E., Scirocco, T., Lorenzetti, G., Bajo, M.,
Penna, P., Francavilla, M., D’Adamo, R., & Guerzoni, S. (2013). Hydrological
Regime and Renewal Capacity of the Micro-tidal Lesina Lagoon, Italy. Estuaries
and Coasts, 37(1), 79–93. https://doi.org/10.1007/s12237-013-9660-x
Ferrarin, C., Tomasin, A., Bajo, M., Petrizzo, A., & Umgiesser,
G. (2015). Tidal changes in a heavily modified coastal wetland. Continental
Shelf Research, 101, 22–33. https://doi.org/10.1016/j.csr.2015.04.002
Gaeta, M. G., Samaras, A. G., Federico, I., Archetti, R., Maicu, F.,
& Lorenzetti, G. (2016). A coupled wave–3-D hydrodynamics model of the
Taranto Sea (Italy): a multiple-nesting approach. Natural Hazards and Earth
System Sciences, 16(9), 2071–2083. https://doi.org/10.5194/nhess-16-2071-2016
Lavaud, L., Bertin, X., Martins, K., & Arnaud, G. (2019). The contribution
of short wave breaking in the storm surge associated with Klaus
(January 24, 2009) in the Southern Bay of Biscay. Coastal Sediments
2019. https://doi.org/10.1142/9789811204487_0123
Neves, L. J. P. F., Barbosa, S. M., & Pereira, A. J. S. C. (2009). Indoor
radon periodicities and their physical constraints: a study in the Coimbra
region (Central Portugal). Journal of Environmental Radioactivity, 100(10),
896–904. https://doi.org/10.1016/j.jenvrad.2009.06.017
Pérez-Ruzafa, A., De Pascalis, F., Ghezzo, M., Quispe-Becerra, J. I.,
Hernández-García, R., Muñoz, I., Vergara, C., Pérez-Ruzafa,
I. M., Umgiesser, G., & Marcos, C. (2019). Connectivity between
coastal lagoons and sea: Asymmetrical effects on assemblages’ and
populations’ structure. Estuarine, Coastal and Shelf Science, 216,
171–186. https://doi.org/10.1016/j.ecss.2018.02.031
Vergara-Chen, C., Pérez-Ruzafa, A., De Pascalis, F., Ghezzo, M.,
Quispe-Becerra, J. I., Hernández-García, R., Muñoz, I., Pérez-Ruzafa,
I. M., Umgiesserb, G. and Marcos, C., (2018). Connectivity between coastal
lagoons and sea: Asymmetrical effects on assemblages' and populations'
structure. https://ridda2.utp.ac.pa/handle/123456789/4432
Vinas, K. A., (2013). Mariana forearc crust CORK pressure
data: observations and implications. University of
Miami. https://scholarship.miami.edu/esploro/outputs/991031448074702976
Žust, L., Fettich, A., Kristan, M., & Ličer, M. (2021). HIDRA
1.0: deep-learning-based ensemble sea level forecasting in
the northern Adriatic. Geoscientific Model Development, 14(4),
2057–2074. https://doi.org/10.5194/gmd-14-2057-2021
Please forward any citation of TAPPY to tim at cerazone.net.
Contributions
-------------
Any help is appreciated. Best would be a pull request on Github or Bitbucket or
if you would like to make a bunch of changes I can assign you developer
privileges to the source code repository. Just contact me at tim at
cerazone.net.
Raw data
{
"_id": null,
"home_page": null,
"name": "tappy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7.1",
"maintainer_email": null,
"keywords": "cli-app, python, tidal-analysis, tide-analysis, tide-filter, tide-prediction",
"author": null,
"author_email": "Tim Cera <tim@cerazone.net>",
"download_url": "https://files.pythonhosted.org/packages/be/af/04592248393cad972c8a7ba9fb196a65d3c8e5f0f354af5ab1b57add9acd/tappy-1.1.0.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/timcera/tappy/actions/workflows/python-package.yml/badge.svg\n :alt: Tests\n :target: https://github.com/timcera/tappy/actions/workflows/python-package.yml\n :height: 20\n\n.. image:: https://img.shields.io/coveralls/github/timcera/tappy\n :alt: Test Coverage\n :target: https://coveralls.io/r/timcera/tappy?branch=master\n :height: 20\n\n.. image:: https://img.shields.io/pypi/v/tappy.svg\n :alt: Latest release\n :target: https://pypi.python.org/pypi/tappy/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/l/tappy.svg\n :alt: BSD-3 clause license\n :target: https://pypi.python.org/pypi/tappy/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/dd/tappy.svg\n :alt: tappy downloads\n :target: https://pypi.python.org/pypi/tappy/\n :height: 20\n\n.. image:: https://img.shields.io/pypi/pyversions/tappy\n :alt: PyPI - Python Version\n :target: https://pypi.org/project/tappy/\n :height: 20\n\nTAPPY is a tidal analysis package. It breaks down a record of water\nlevels into the component sine waves. It is written in Python and uses\nthe least squares optimization and other functions in\n`SciPy <http://www.scipy.org>`__. The focus is to make the most accurate\nanalysis possible. TAPPY only determines the constituents that are\ncalculable according to the length of the time series.\n\nFeatures\n--------\n\n- Outputs a \u2018International Hydrographic Organization - Tidal and Water\n Level Working Group\u2019 standard XML constituent file.\n- Uses the IHO standard XML constituent file to make a predicted time\n series. By far the most frequent request that I get.\n- Calculates the node factor at each water elevation measurement. Very\n important for long time-series (greater than a year).\n- Very accurate ephemeris calculations thanks to the\n `Astrolabe <http://astrolabe.sourceforge.net>`__ library.\n- Able to read in different input data sets without changing TAPPY or\n the input data set. All you have to do is create a file that defines\n the input data set. Thanks to\n `Pyparsing <http://pyparsing.wikispaces.com/>`__.\n- Added the capability to read compressed files and Internet data\n streams (actually any URL) directly into TAPPY by using\n `filelike <http://www.rfk.id.au/software/filelike/>`__.\n- The time-series does not need to have equal intervals. In fact any\n length of missing data is allowed (though too much missing will cause\n a poor analysis).\n- Can adjust the Rayleigh factor that nearby constituents are compared\n against to determine what constituents can be differentiated.\n- TAPPY chooses the main constituents based upon the length of the time\n series and infers additional constituents that are known to be\n specifically related to the main constituents.\n- Can filter the tidal energy out of the input signal using transform\n (FFT), usgs (PL33), doodson, and boxcar methods. \\|\n [CompareTidalFilters]\n- Can use the tidal filters to zero the time-series before\n determination of tidal constituents.\n- Can pad the usgs, doodson, and boxcar filters with predicted data to\n minimize edge effects of the filters.\n- Convenience function to fill missing values with the predicted time series\n\nRequirements\n------------\n\n`Python version 3.7.1 or later <http://www.python.org>`__\n\n`SciPy <http://www.scipy.org>`__\n\n\nInstall\n-------\n\n::\n\n # To install...\n pip install tappy\n\n\nTAPPY Citations\n---------------\nAkmal, P. N. E., (2013). Determination of the Permeability of\nthe South Chamorro Seamount in Mariana Forearc Crust Using\nPressure Response to Tidal Loading Method. University of\nMiami. https://scholarship.miami.edu/esploro/outputs/991031448068902976\n\nBarbosa, S. M., (2009). Analysis of trends in North Atlantic tidal\namplitudes University of Porto, Portugal (susana.barbosa@fc.up.pt)\nhttp://meetingorganizer.copernicus.org/EGU2009/EGU2009-5154.pdf\n\nBechet, V., Verstraeten, E., Hanert, E. & Deleersnijder, E.,\n(2018). Multiple-year marine connectivity modeling in the Florida Coral\nReef Tract to assess Acropora Cervicornis recovery. (Unpublished master\u2019s\nthesis). Ecole polytechnique de Louvain, Universit\u00e9 catholique de Louvain.\n\nBecker, K., Davis, E. E., & Villinger, H. (2022). Long\u2010Term Observations\nof Subseafloor Temperatures and Pressures in a Low\u2010Temperature,\nOff\u2010Axis Hydrothermal System in North Pond on the Western Flank\nof the Mid\u2010Atlantic Ridge. Geochemistry, Geophysics, Geosystems,\n23(9). Portico. https://doi.org/10.1029/2022gc010496\n\nBillings, W. Z., (2018). An Exploration of the Two-Dimensional Poroelastic\nProperties of Oceanic Crust at the Formation Scale. University of\nMiami\u2009ProQuest Dissertations Publishing, \u200910846298.\n\nCampos, E. J. D., Kjerfve, B., Cavalcante, G., Vieira, F., & Abouleish,\nM. (2022). Water exchange across the Strait of Hormuz. Effects of\ntides and rivers runoff. Regional Studies in Marine Science, 52,\n102336. https://doi.org/10.1016/j.rsma.2022.102336\n\nCucco, A., Mart\u00edn, J., Quattrocchi, G., Fenco, H., Umgiesser, G., &\nFern\u00e1ndez, D. A. (2022). Water Circulation and Transport Time Scales in\nthe Beagle Channel, Southernmost Tip of South America. Journal of Marine\nScience and Engineering, 10(7), 941. https://doi.org/10.3390/jmse10070941\n\nDesmet, N., (2019). Modelling coral larvae exchanges between the Great\nBarrier Reef and outer reefs. Ecole polytechnique de Louvain, Universit\u00e9\ncatholique de Louvain. Prom. : Hanert, Emmanuel ; Deleersnijder,\nEric. http://hdl.handle.net/2078.1/thesis:19591\n\nFerrarin, C., Roland, A., Bajo, M., Umgiesser, G., Cucco, A., Davolio, S.,\nBuzzi, A., Malguzzi, P., & Drofa, O. (2013). Tide-surge-wave modelling and\nforecasting in the Mediterranean Sea with focus on the Italian coast. Ocean\nModelling, 61, 38\u201348. https://doi.org/10.1016/j.ocemod.2012.10.003\n\nFerrarin, C., Zaggia, L., Paschini, E., Scirocco, T., Lorenzetti, G., Bajo, M.,\nPenna, P., Francavilla, M., D\u2019Adamo, R., & Guerzoni, S. (2013). Hydrological\nRegime and Renewal Capacity of the Micro-tidal Lesina Lagoon, Italy. Estuaries\nand Coasts, 37(1), 79\u201393. https://doi.org/10.1007/s12237-013-9660-x\n\nFerrarin, C., Tomasin, A., Bajo, M., Petrizzo, A., & Umgiesser,\nG. (2015). Tidal changes in a heavily modified coastal wetland. Continental\nShelf Research, 101, 22\u201333. https://doi.org/10.1016/j.csr.2015.04.002\n\nGaeta, M. G., Samaras, A. G., Federico, I., Archetti, R., Maicu, F.,\n& Lorenzetti, G. (2016). A coupled wave\u20133-D hydrodynamics model of the\nTaranto Sea (Italy): a multiple-nesting approach. Natural Hazards and Earth\nSystem Sciences, 16(9), 2071\u20132083. https://doi.org/10.5194/nhess-16-2071-2016\n\nLavaud, L., Bertin, X., Martins, K., & Arnaud, G. (2019). The contribution\nof short wave breaking in the storm surge associated with Klaus\n(January 24, 2009) in the Southern Bay of Biscay. Coastal Sediments\n2019. https://doi.org/10.1142/9789811204487_0123\n\nNeves, L. J. P. F., Barbosa, S. M., & Pereira, A. J. S. C. (2009). Indoor\nradon periodicities and their physical constraints: a study in the Coimbra\nregion (Central Portugal). Journal of Environmental Radioactivity, 100(10),\n896\u2013904. https://doi.org/10.1016/j.jenvrad.2009.06.017\n\nP\u00e9rez-Ruzafa, A., De Pascalis, F., Ghezzo, M., Quispe-Becerra, J. I.,\nHern\u00e1ndez-Garc\u00eda, R., Mu\u00f1oz, I., Vergara, C., P\u00e9rez-Ruzafa,\nI. M., Umgiesser, G., & Marcos, C. (2019). Connectivity between\ncoastal lagoons and sea: Asymmetrical effects on assemblages\u2019 and\npopulations\u2019 structure. Estuarine, Coastal and Shelf Science, 216,\n171\u2013186. https://doi.org/10.1016/j.ecss.2018.02.031\n\nVergara-Chen, C., P\u00e9rez-Ruzafa, A., De Pascalis, F., Ghezzo, M.,\nQuispe-Becerra, J. I., Hern\u00e1ndez-Garc\u00eda, R., Mu\u00f1oz, I., P\u00e9rez-Ruzafa,\nI. M., Umgiesserb, G. and Marcos, C., (2018). Connectivity between coastal\nlagoons and sea: Asymmetrical effects on assemblages' and populations'\nstructure. https://ridda2.utp.ac.pa/handle/123456789/4432\n\nVinas, K. A., (2013). Mariana forearc crust CORK pressure\ndata: observations and implications. University of\nMiami. https://scholarship.miami.edu/esploro/outputs/991031448074702976\n\n\u017dust, L., Fettich, A., Kristan, M., & Li\u010der, M. (2021). HIDRA\n1.0: deep-learning-based ensemble sea level forecasting in\nthe northern Adriatic. Geoscientific Model Development, 14(4),\n2057\u20132074. https://doi.org/10.5194/gmd-14-2057-2021\n\nPlease forward any citation of TAPPY to tim at cerazone.net.\n\nContributions\n-------------\nAny help is appreciated. Best would be a pull request on Github or Bitbucket or\nif you would like to make a bunch of changes I can assign you developer\nprivileges to the source code repository. Just contact me at tim at\ncerazone.net.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Command line script and Python library perform tidally-based analysis of water level data.",
"version": "1.1.0",
"project_urls": {
"bitbucket": "https://bitbucket.org/timcera/tappy/src/main/",
"documentation": "https://timcera.bitbucket.io/tappy/docs/index.html#tappy-documentation",
"github": "https://github.com/timcera/tappy"
},
"split_keywords": [
"cli-app",
" python",
" tidal-analysis",
" tide-analysis",
" tide-filter",
" tide-prediction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff0bff1ab70b53806251931ea857070e323e11315b83d414437634090dea0c40",
"md5": "ca3a20f3a0ce901441fb7ddd7b576eb6",
"sha256": "d98bfb358d87b57710836e91f2f37b9ee2a406a4f9aed6f2a480a548f8986e01"
},
"downloads": -1,
"filename": "tappy-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca3a20f3a0ce901441fb7ddd7b576eb6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1",
"size": 100449,
"upload_time": "2024-04-01T03:09:36",
"upload_time_iso_8601": "2024-04-01T03:09:36.563385Z",
"url": "https://files.pythonhosted.org/packages/ff/0b/ff1ab70b53806251931ea857070e323e11315b83d414437634090dea0c40/tappy-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "beaf04592248393cad972c8a7ba9fb196a65d3c8e5f0f354af5ab1b57add9acd",
"md5": "959aaf9988e94b2abf77af1bd08bebc1",
"sha256": "b6d5e91713af211cffbd24549180e9f0ff88d6573243246bee161252e611eb45"
},
"downloads": -1,
"filename": "tappy-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "959aaf9988e94b2abf77af1bd08bebc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1",
"size": 751767,
"upload_time": "2024-04-01T03:09:33",
"upload_time_iso_8601": "2024-04-01T03:09:33.171934Z",
"url": "https://files.pythonhosted.org/packages/be/af/04592248393cad972c8a7ba9fb196a65d3c8e5f0f354af5ab1b57add9acd/tappy-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 03:09:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timcera",
"github_project": "tappy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tappy"
}
JSON
