Quick Start

Platform Support

cr-wavelets can run on any platform supported by JAX. We have tested cr-wavelets on Mac and Linux platforms and Google Colaboratory.

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.

Installation

Installation from PyPI:

python -m pip install cr-wavelets

Directly from our GITHUB repository:

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

Note

If you are on Windows, JAX is not yet officially supported. However, you can install an unofficial JAX build for windows from https://github.com/cloudhan/jax-windows-builder. This works quite well for development purposes.

Examples

• See the examples gallery.

Note

cr-wavelets depends on its sister library cr-nimble. Normally, it would be installed automatically as a dependency. You may want to install it directly from GITHUB if you need access to the latest code.

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