Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
shailesh1729 committed Aug 27, 2022
1 parent 6c75a62 commit f9da6ef
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,5 @@ docs/gallery/
# airspeed velocity benchmark results
.asv/*
paper/paper.pdf

*.html
42 changes: 40 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# cr-nimble
Iterative algorithms for numerical linear algebra with JAX
# CR-Nimble

`CR-Nimble` consists of fast linear algebra
and signal processing routines.
Most of the routines have been implemented using
Google JAX. Thus, they can be easily run on
a variety of hardware (CPU, GPU, TPU).

Functionality includes:

* Utility functions for working with vectors, matrices and arrays
* Linear algebra functions
* Digital signal processing functions
* Data compression functions
* Test data generation functions


Installation

```{shell}
python -m pip install cr-nimble
```

Import

```{python}
import cr.nimble as crn
```

See [documentation](https://cr-nimble.readthedocs.io)
for library usage.

`CR-Nimble` is part of
[CR-Suite](https://carnotresearch.github.io/cr-suite/).

Related libraries:

* [CR-Wavelets](https://cr-wavelets.readthedocs.io)
* [CR-Sparse](https://cr-sparse.readthedocs.io)


[![codecov](https://codecov.io/gh/carnotresearch/cr-nimble/branch/main/graph/badge.svg?token=PX1MGTZ7VL)](https://codecov.io/gh/carnotresearch/cr-nimble)
[![Unit Tests](https://github.com/carnotresearch/cr-nimble/actions/workflows/ci.yml/badge.svg)](https://github.com/carnotresearch/cr-nimble/actions/workflows/ci.yml)
Expand Down

0 comments on commit f9da6ef

Please sign in to comment.