Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jflamant committed Jun 4, 2023
1 parent 89d6931 commit 38677fe
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
@@ -1,7 +1,7 @@
# BiSPy : Bivariate Signal Processing with Python

[![Documentation](https://readthedocs.org/projects/bispy/badge/?style=default)](https://bispy.readthedocs.org)
[![Build Status](https://travis-ci.org/jflamant/bispy.svg?branch=master)](https://travis-ci.org/jflamant/bispy)
[![docs-page](https://img.shields.io/badge/docs-latest-blue)](https://jflamant.github.io/bispy/)
[![PyPI version](https://badge.fury.io/py/bispy-polar.svg)](https://badge.fury.io/py/bispy-polar)

BiSPy is an open-source python framework for processing bivariate signals. It supports our papers on time-frequency analysis [1], spectral analysis [2] and linear time-invariant filtering [3] of bivariate signals.

Expand All @@ -16,6 +16,21 @@ These papers contains theoretical results and several applications that can be r

This python toolbox is currently under development and is hosted on GitHub. If you encounter a bug or something unexpected please let me know by [raising an issue](https://github.com/jflamant/bispy/issues) on the project page.

### Install from PyPi

Due to name conflict the available version on PyPi is named ``bispy-polar''. To install from PyPi, simply type

```
pip install bispy-polar
```

It will automatically install dependencies (see also below).

To get started, simply use
```
import bispy as bsp
```

Requirements
============
BiSPy works with python 3.5+.
Expand All @@ -31,22 +46,8 @@ To install dependencies:
pip install numpy scipy matplotlib numpy-quaternion
```

[quaternion](https://github.com/moble/quaternion) add quaternion dtype support to numpy. Implementation by [moble]. Since this python toolbox relies extensively on this module, you can check out first the nice introduction [here](https://github.com/moble).

### Install from sources
[numpy-quaternion](https://github.com/moble/quaternion) add quaternion dtype support to numpy. Implementation by [moble]. Since this python toolbox relies extensively on this module, you can check out first the nice introduction [here](https://github.com/moble).

Clone this repository

```bash
git clone https://github.com/jflamant/bispy.git
cd bispy
```

And execute `setup.py`

```bash
pip install .
```

License
=======
Expand Down

0 comments on commit 38677fe

Please sign in to comment.