Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/carnotresearch/cr-wavelets

Wavelets with JAX

https://github.com/carnotresearch/cr-wavelets

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary

Keywords

compression dwt wavelet-analysis wavelet-compression wavelets
Last synced: 5 months ago · JSON representation

Repository

Wavelets with JAX

Basic Info
Statistics
  • Stars: 7
  • Watchers: 1
  • Forks: 2
  • Open Issues: 0
  • Releases: 3
Topics
compression dwt wavelet-analysis wavelet-compression wavelets
Created over 3 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct

README.rst 

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


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


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


``CR-Wavelets`` is a port of `PyWavelets` for
`Google JAX `_. 
It enables running Wavelet decomposition and reconstruction
algorithms on GPU and TPU hardware.

For detailed documentation and usage, please visit `online docs `_.

For theoretical background, please check online notes at `Topics in Signal Processing `_
and references therein (still under development).

``CR-Wavelets`` is part of
`CR-Suite `_.

Related libraries:

* `CR-Nimble `_
* `CR-Sparse `_



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.4.

``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 `_ in the documentation.


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

* `Contribution Guidelines `_
* `Code of Conduct `_


`Documentation `_ | 
`Code `_ | 
`Issues `_ | 
`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&utm_medium=referral&utm_content=carnotresearch/cr-wavelets&utm_campaign=Badge_Grade

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

Owner

  • Name: Carnot Research Pvt. Ltd.
  • Login: carnotresearch
  • Kind: organization

GitHub Events

Total
Last Year

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 30
  • Total Committers: 1
  • Avg Commits per committer: 30.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Shailesh Kumar s****k@g****m 30

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 76 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 3
  • Total maintainers: 1
pypi.org: cr-wavelets

Wavelets with JAX

  • Versions: 3
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 76 Last month
Rankings
Dependent packages count: 4.7%
Average: 18.2%
Downloads: 20.4%
Stargazers count: 21.5%
Dependent repos count: 21.7%
Forks count: 22.6%
Maintainers (1)
carnotresearch
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • IPython >=7.16.1
  • PyWavelets *
  • chex >=0.0.4
  • click *
  • imageio *
  • ipykernel >=5.3.4
  • jax >=0.3.14
  • jaxlib >=0.3.14
  • matplotlib *
  • myst-parser *
  • nbsphinx >=0.8.0
  • numpy >=1.20.0
  • pandas *
  • pillow *
  • requests *
  • scikit-image *
  • scikit-learn *
  • scipy >=1.6
  • sphinx ==4.0.0
  • sphinx-autodoc-typehints >=1.11.1
  • sphinx-gallery >=0.8.0
  • sphinx-panels *
  • sphinxcontrib-bibtex >=1.0.0
  • sphinxcontrib-katex >=0.7.1
  • sympy >=1.6
requirements/requirements-docs.txt pypi
  • IPython >=7.16.1
  • cr-nimble *
  • ipykernel >=5.3.4
  • nbsphinx >=0.8.0
  • pandoc >>=1.0.2
  • requests *
  • sphinx >=3.3.0
  • sphinx-autodoc-typehints >=1.11.1
  • sphinx_rtd_theme >=0.5.0
  • sphinxcontrib-bibtex >=1.0.0
  • sphinxcontrib-katex >=0.7.1
requirements/requirements-tests.txt pypi
  • pytest * test
  • pytest-cov * test
requirements/requirements.txt pypi
  • chex >=0.0.4
  • click *
  • cr-nimble *
  • imageio *
  • jax >=0.3.14
  • jaxlib >=0.3.14
  • matplotlib *
  • numpy >=1.18.0
  • pandas >=1.0.0
  • requests >=2.20.0
  • scipy *
  • sympy >=1.6
requirements.txt pypi
  • click *
  • imageio *
  • matplotlib *
  • numpy *
  • pytest *
  • scipy *
  • tensorflow *
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v1 composite
  • zcong1993/setup-timezone master composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/sphinx.yaml actions
  • actions/cache v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • ammaraskar/sphinx-problem-matcher master composite
  • peaceiris/actions-gh-pages v3 composite
requirements/requirements-examples.txt pypi
  • cr-nimble >=0.4.0
setup.py pypi
tests/setup.py pypi