Metadata-Version: 2.4
Name: pywavelet
Version: 0.2.10
Summary: WDM wavelet transform your time/freq series!
Author-email: Pywavelet Team <avi.vajpeyi@gmail.com>
Project-URL: Homepage, https://pywavelet.github.io/pywavelet/
Project-URL: Bug Reports, https://pywavelet.com/pywavelet/pywavelet/issues
Project-URL: Source, https://github.com/pywavelet/pywavelet/
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: numba
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: tqdm
Requires-Dist: rich
Requires-Dist: rocket-fft
Requires-Dist: astropy>=5.2.1
Requires-Dist: jaxtyping
Requires-Dist: beartype
Requires-Dist: click
Provides-Extra: jax
Requires-Dist: jax; extra == "jax"
Provides-Extra: cupy
Requires-Dist: cupy; extra == "cupy"
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: flake8>=5.0.4; extra == "dev"
Requires-Dist: black>=22.12.0; extra == "dev"
Requires-Dist: black[jupyter]>=22.12.0; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: jupyter-book; extra == "dev"
Requires-Dist: GitPython; extra == "dev"
Requires-Dist: nbconvert; extra == "dev"
Requires-Dist: pytest-click; extra == "dev"
Requires-Dist: pandas; extra == "dev"
Dynamic: license-file

pywavelet
#########

.. image:: https://badge.fury.io/py/pywavelet.svg
    :target: https://badge.fury.io/py/pywavelet
.. image:: https://coveralls.io/repos/github/avivajpeyi/pywavelet/badge.svg?branch=main&kill_cache=1
    :target: https://coveralls.io/github/avivajpeyi/pywavelet?branch=main





WDM Wavelet transform


Quickstart
==========

pywavelet is available on PyPI and can be installed with `pip <https://pip.pypa.io>`_.

.. code-block:: console

    $ pip install pywavelet


Note: We have transforms availible in numpy, JAX and Cupy.


For developers
--------------

First set up a conda environment with python 3.10

.. code-block::

    $ mamba create -n pywavelet python=3.10

.. code-block::

    $ CONDA_OVERRIDE_CUDA=12.4  mamba install "jaxlib=*=*cuda*" jax -c conda-forge
    $ CONDA_OVERRIDE_CUDA=12.4  conda install -c conda-forge cupy-core
    $ pip install -e ".[dev]"
    $ pre-commit install

Test code
---------

Locate directory /tests from root directory. run

.. code-block::

    $ pytest .

Hopefully everything should run fine.
