pycwt


Namepycwt JSON
Version 0.4.0b0 PyPI version JSON
download
home_page
SummaryContinuous wavelet transform module for Python.
upload_time2023-03-15 02:37:56
maintainer
docs_urlNone
authorNabil Freij, and contributors
requires_python>=3.8
licensePyCWT is released under a BSD-style open source licence: Copyright (c) 2023 Sebastian Krieger, Nabil Freij, and contributors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords wavelet spectral analysis signal processing data science timeseries time series
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            |ReadTheDocs| |PyPi| |Travis|

PyCWT
=====

A Python module for continuous wavelet spectral analysis. It includes a
collection of routines for wavelet transform and statistical analysis via FFT
algorithm. In addition, the module also includes cross-wavelet transforms,
wavelet coherence tests and sample scripts.

Please read the documentation `here <http://pycwt.readthedocs.io/en/latest/>`__\.

This module requires ``NumPy``, ``SciPy``, ``tqdm``. In addition, you will 
also need ``matplotlib`` to run the examples.

The sample scripts (``sample.py``, ``sample_xwt.py``) illustrate the use of
the wavelet and inverse wavelet transforms, cross-wavelet transform and
wavelet transform coherence. Results are plotted in figures similar to the
sample images.


Disclaimer
----------

This module is based on routines provided by C. Torrence and G. P. Compo
available at http://paos.colorado.edu/research/wavelets/, on routines
provided by A. Grinsted, J. Moore and S. Jevrejeva available at
http://noc.ac.uk/using-science/crosswavelet-wavelet-coherence, and
on routines provided by A. Brazhe available at
http://cell.biophys.msu.ru/static/swan/.

This software is released under a BSD-style open source license. Please read
the license file for further information. This routine is provided as is
without any express or implied warranties whatsoever.


Installation
------------

We recommend using PyPI to install this package.

.. code-block:: sh

    $ pip install pycwt

However, if you want to install directly from GitHub, use:

.. code-block:: sh

    $ pip install git+https://github.com/regeirk/pycwt


Acknowledgements
----------------

We would like to thank Christopher Torrence, Gilbert P. Compo, Aslak Grinsted,
John Moore, Svetlana Jevrejevaand and Alexey Brazhe for their code and also
Jack Ireland and Renaud Dussurget for their attentive eyes, feedback and
debugging.


Contributors
------------

- Sebastian Krieger
- Nabil Freij
- Ken Mankoff
- Aaron Nielsen
- Rodrigo Nemmen
- Ondrej Grover
- Joscelin Rocha Hidalgo
- Stuart Mumford
- ymarcon1
- Tariq Hassan


References
----------

1. Torrence, C. and Compo, G. P.. A Practical Guide to Wavelet
   Analysis. Bulletin of the American Meteorological Society, *American
   Meteorological Society*, **1998**, 79, 61-78.
2. Torrence, C. and Webster, P. J.. Interdecadal changes in the
   ENSO-Monsoon system, *Journal of Climate*, **1999**, 12(8),
   2679-2690.
3. Grinsted, A.; Moore, J. C. & Jevrejeva, S. Application of the cross
   wavelet transform and wavelet coherence to geophysical time series.
   *Nonlinear Processes in Geophysics*, **2004**, 11, 561-566.
4. Mallat, S.. A wavelet tour of signal processing: The sparse way.
   *Academic Press*, **2008**, 805.
5. Addison, P. S. The illustrated wavelet transform handbook:
   introductory theory and applications in science, engineering,
   medicine and finance. *IOP Publishing*, **2002**.
6. Liu, Y., Liang, X. S. and Weisberg, R. H. Rectification of the bias
   in the wavelet power spectrum. *Journal of Atmospheric and Oceanic
   Technology*, **2007**, 24, 2093-2102.


.. |ReadTheDocs| image:: https://readthedocs.org/projects/pycwt/badge/?version=latest
   :target: http://pycwt.readthedocs.io/en/latest/?badge=latest

.. |PyPi| image:: https://badge.fury.io/py/pycwt.svg
   :target: https://badge.fury.io/py/pycwt

.. |Travis| image:: https://travis-ci.org/regeirk/pycwt.svg?branch=master
   :target: https://travis-ci.org/regeirk/pycwt

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pycwt",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Sebastian Krieger <sebastian@nublia.com>",
    "keywords": "wavelet,spectral analysis,signal processing,data science,timeseries,time series",
    "author": "Nabil Freij, and contributors",
    "author_email": "Sebastian Krieger <sebastian@nublia.com>",
    "download_url": "https://files.pythonhosted.org/packages/14/7d/45a8495c87d1332a1a8b457e02ee9e0e0ce8ea0e544ecbab890e79a89c46/pycwt-0.4.0b0.tar.gz",
    "platform": null,
    "description": "|ReadTheDocs| |PyPi| |Travis|\n\nPyCWT\n=====\n\nA Python module for continuous wavelet spectral analysis. It includes a\ncollection of routines for wavelet transform and statistical analysis via FFT\nalgorithm. In addition, the module also includes cross-wavelet transforms,\nwavelet coherence tests and sample scripts.\n\nPlease read the documentation `here <http://pycwt.readthedocs.io/en/latest/>`__\\.\n\nThis module requires ``NumPy``, ``SciPy``, ``tqdm``. In addition, you will \nalso need ``matplotlib`` to run the examples.\n\nThe sample scripts (``sample.py``, ``sample_xwt.py``) illustrate the use of\nthe wavelet and inverse wavelet transforms, cross-wavelet transform and\nwavelet transform coherence. Results are plotted in figures similar to the\nsample images.\n\n\nDisclaimer\n----------\n\nThis module is based on routines provided by C. Torrence and G. P. Compo\navailable at http://paos.colorado.edu/research/wavelets/, on routines\nprovided by A. Grinsted, J. Moore and S. Jevrejeva available at\nhttp://noc.ac.uk/using-science/crosswavelet-wavelet-coherence, and\non routines provided by A. Brazhe available at\nhttp://cell.biophys.msu.ru/static/swan/.\n\nThis software is released under a BSD-style open source license. Please read\nthe license file for further information. This routine is provided as is\nwithout any express or implied warranties whatsoever.\n\n\nInstallation\n------------\n\nWe recommend using PyPI to install this package.\n\n.. code-block:: sh\n\n    $ pip install pycwt\n\nHowever, if you want to install directly from GitHub, use:\n\n.. code-block:: sh\n\n    $ pip install git+https://github.com/regeirk/pycwt\n\n\nAcknowledgements\n----------------\n\nWe would like to thank Christopher Torrence, Gilbert P. Compo, Aslak Grinsted,\nJohn Moore, Svetlana Jevrejevaand and Alexey Brazhe for their code and also\nJack Ireland and Renaud Dussurget for their attentive eyes, feedback and\ndebugging.\n\n\nContributors\n------------\n\n- Sebastian Krieger\n- Nabil Freij\n- Ken Mankoff\n- Aaron Nielsen\n- Rodrigo Nemmen\n- Ondrej Grover\n- Joscelin Rocha Hidalgo\n- Stuart Mumford\n- ymarcon1\n- Tariq Hassan\n\n\nReferences\n----------\n\n1. Torrence, C. and Compo, G. P.. A Practical Guide to Wavelet\n   Analysis. Bulletin of the American Meteorological Society, *American\n   Meteorological Society*, **1998**, 79, 61-78.\n2. Torrence, C. and Webster, P. J.. Interdecadal changes in the\n   ENSO-Monsoon system, *Journal of Climate*, **1999**, 12(8),\n   2679-2690.\n3. Grinsted, A.; Moore, J. C. & Jevrejeva, S. Application of the cross\n   wavelet transform and wavelet coherence to geophysical time series.\n   *Nonlinear Processes in Geophysics*, **2004**, 11, 561-566.\n4. Mallat, S.. A wavelet tour of signal processing: The sparse way.\n   *Academic Press*, **2008**, 805.\n5. Addison, P. S. The illustrated wavelet transform handbook:\n   introductory theory and applications in science, engineering,\n   medicine and finance. *IOP Publishing*, **2002**.\n6. Liu, Y., Liang, X. S. and Weisberg, R. H. Rectification of the bias\n   in the wavelet power spectrum. *Journal of Atmospheric and Oceanic\n   Technology*, **2007**, 24, 2093-2102.\n\n\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/pycwt/badge/?version=latest\n   :target: http://pycwt.readthedocs.io/en/latest/?badge=latest\n\n.. |PyPi| image:: https://badge.fury.io/py/pycwt.svg\n   :target: https://badge.fury.io/py/pycwt\n\n.. |Travis| image:: https://travis-ci.org/regeirk/pycwt.svg?branch=master\n   :target: https://travis-ci.org/regeirk/pycwt\n",
    "bugtrack_url": null,
    "license": "PyCWT is released under a BSD-style open source licence:  Copyright (c) 2023 Sebastian Krieger, Nabil Freij, and contributors. All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \u201cAS IS\u201d AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Continuous wavelet transform module for Python.",
    "version": "0.4.0b0",
    "split_keywords": [
        "wavelet",
        "spectral analysis",
        "signal processing",
        "data science",
        "timeseries",
        "time series"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "460ed4e87cb23825ba32b175fa95f64a4bd2934d0687269789dc37a883e041d3",
                "md5": "4bdce472b8bbc13b1f59e1129d838e09",
                "sha256": "a8b8b9bfbd87f5c2e9eec54cf71a845eb42f9a22831141bf2c49ff01a3d459f0"
            },
            "downloads": -1,
            "filename": "pycwt-0.4.0b0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4bdce472b8bbc13b1f59e1129d838e09",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 753514,
            "upload_time": "2023-03-15T02:37:52",
            "upload_time_iso_8601": "2023-03-15T02:37:52.836039Z",
            "url": "https://files.pythonhosted.org/packages/46/0e/d4e87cb23825ba32b175fa95f64a4bd2934d0687269789dc37a883e041d3/pycwt-0.4.0b0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "147d45a8495c87d1332a1a8b457e02ee9e0e0ce8ea0e544ecbab890e79a89c46",
                "md5": "e20324a5f789ffb09b0337ab7ece38f4",
                "sha256": "f337cd28531f5b49a62b5f3ba5657cbc3e2f69e15a12ee3d309a2aa5ca1b8e86"
            },
            "downloads": -1,
            "filename": "pycwt-0.4.0b0.tar.gz",
            "has_sig": false,
            "md5_digest": "e20324a5f789ffb09b0337ab7ece38f4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 760284,
            "upload_time": "2023-03-15T02:37:56",
            "upload_time_iso_8601": "2023-03-15T02:37:56.729992Z",
            "url": "https://files.pythonhosted.org/packages/14/7d/45a8495c87d1332a1a8b457e02ee9e0e0ce8ea0e544ecbab890e79a89c46/pycwt-0.4.0b0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-15 02:37:56",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pycwt"
}
        
Elapsed time: 0.04364s