Metadata-Version: 2.1
Name: cr-wavelets
Version: 0.3.0
Summary: Wavelets with JAX
Home-page: https://carnotresearch.github.io/cr-wavelets
Author: CR-Wavelets Development Team
Author-email: contact@carnotresearch.com
License: Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0
Download-URL: https://github.com/carnotresearch/cr-wavelets/archive/v0.3.0.tar.gz
Project-URL: Issue Tracker, https://github.com/carnotresearch/cr-wavelets/issues
Keywords: Computer Vision
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Multimedia
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: chex (>=0.0.4)
Requires-Dist: jax (>=0.3.14)
Requires-Dist: jaxlib (>=0.3.14)
Requires-Dist: numpy (>=1.18.0)
Requires-Dist: sympy (>=1.6)
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: pandas (>=1.0.0)
Requires-Dist: requests (>=2.20.0)
Requires-Dist: imageio
Requires-Dist: click
Requires-Dist: cr-nimble (>=0.3.0)
Provides-Extra: dev
Provides-Extra: docs
Requires-Dist: sphinx (>=3.3.0) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (>=0.5.0) ; extra == 'docs'
Requires-Dist: sphinxcontrib-katex (>=0.7.1) ; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex (>=1.0.0) ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints (>=1.11.1) ; extra == 'docs'
Requires-Dist: IPython (>=7.16.1) ; extra == 'docs'
Requires-Dist: ipykernel (>=5.3.4) ; extra == 'docs'
Requires-Dist: pandoc (>>=1.0.2) ; extra == 'docs'
Requires-Dist: nbsphinx (>=0.8.0) ; extra == 'docs'
Requires-Dist: requests ; extra == 'docs'
Requires-Dist: cr-nimble ; extra == 'docs'
Provides-Extra: examples
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'

Wavelets with JAX
==================================================================


|pypi| |license| |zenodo| |docs| |unit_tests| |coverage|


Introduction
-------------------


``CR-Wavelets`` is a Python library that enables efficiently solving
a wide variety of sparse representation based signal processing problems.
It is a cohesive collection of sub-libraries working together. Individual
sub-libraries provide functionalities for:
wavelets, linear operators, greedy and convex optimization 
based sparse recovery algorithms, subspace clustering, 
standard signal processing transforms,
and linear algebra subroutines for solving sparse linear systems. 
It has been built using `Google JAX <https://jax.readthedocs.io/en/latest/>`_, 
which enables the same high level
Python code to get efficiently compiled on CPU, GPU and TPU architectures
using `XLA <https://www.tensorflow.org/xla>`_. 

For detailed documentation and usage, please visit `online docs <https://cr-wavelets.readthedocs.io/en/latest>`_.

For theoretical background, please check online notes at `Topics in Signal Processing <https://tisp.indigits.com>`_
and references therein (still under development).

``CR-Wavelets`` is part of
`CR-Suite <https://carnotresearch.github.io/cr-suite/>`_.

Related libraries:

* `CR-Nimble <https://cr-nimble.readthedocs.io>`_
* `CR-Sparse <https://cr-sparse.readthedocs.io>`_



Supported Platforms
----------------------

``CR-Wavelets`` can run on any platform supported by ``JAX``. 
We have tested ``CR-Wavelets`` on Mac and Linux platforms and Google Colaboratory.

* The latest code in the library has been tested against JAX 0.3.14.

``JAX`` is not officially supported on Windows platforms at the moment. 
Although, it is possible to build it from source using Windows Subsystems for Linux.
Alternatively, you can check out the community supported Windows build for JAX
available from https://github.com/cloudhan/jax-windows-builder.
This seems to work well and all the unit tests in the library have passed
on Windows also. 

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

Installation from PyPI:

.. code:: shell

    python -m pip install cr-wavelets

Directly from our GITHUB repository:

.. code:: shell

    python -m pip install git+https://github.com/carnotresearch/cr-wavelets.git



Examples/Usage
----------------

See the `examples gallery <https://cr-wavelets.readthedocs.io/en/latest/gallery/index.html>`_ in the documentation.


Contribution Guidelines/Code of Conduct
----------------------------------------

* `Contribution Guidelines <CONTRIBUTING.md>`_
* `Code of Conduct <CODE_OF_CONDUCT.md>`_


`Documentation <https://carnotresearch.github.io/cr-wavelets>`_ | 
`Code <https://github.com/carnotresearch/cr-wavelets>`_ | 
`Issues <https://github.com/carnotresearch/cr-wavelets/issues>`_ | 
`Discussions <https://github.com/carnotresearch/cr-wavelets/discussions>`_ |


.. |docs| image:: https://readthedocs.org/projects/cr-wavelets/badge/?version=latest
    :target: https://cr-wavelets.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |unit_tests| image:: https://github.com/carnotresearch/cr-wavelets/actions/workflows/ci.yml/badge.svg
    :alt: Unit Tests
    :target: https://github.com/carnotresearch/cr-wavelets/actions/workflows/ci.yml


.. |pypi| image:: https://badge.fury.io/py/cr-wavelets.svg
    :alt: PyPI cr-wavelets
    :target: https://badge.fury.io/py/cr-wavelets

.. |coverage| image:: https://codecov.io/gh/carnotresearch/cr-wavelets/branch/master/graph/badge.svg?token=JZQW6QU3S4
    :alt: Coverage
    :target: https://codecov.io/gh/carnotresearch/cr-wavelets


.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
    :alt: License
    :target: https://opensource.org/licenses/Apache-2.0

.. |codacy| image:: https://app.codacy.com/project/badge/Grade/36905009377e4a968124dabb6cd24aae
    :alt: Codacy Badge
    :target: https://www.codacy.com/gh/carnotresearch/cr-wavelets/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=carnotresearch/cr-wavelets&amp;utm_campaign=Badge_Grade

.. |zenodo| image:: https://zenodo.org/badge/525693334.svg
    :alt: DOI
    :target: https://zenodo.org/badge/latestdoi/525693334


