# 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)
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.
> [1] Julien Flamant, Nicolas Le Bihan, Pierre Chainais: “Time-frequency analysis of bivariate signals”, In press, Applied and Computational Harmonic Analysis, 2017; [arXiv:1609.0246](http://arxiv.org/abs/1609.02463), [doi:10.1016/j.acha.2017.05.007](https://doi.org/10.1016/j.acha.2017.05.007)
> [2] Julien Flamant, Nicolas Le Bihan, Pierre Chainais: “Spectral analysis of stationary random bivariate signals”, 2017, IEEE Transactions on Signal Processing; [arXiv:1703.06417](http://arxiv.org/abs/1703.06417), [doi:10.1109/TSP.2017.2736494](https://doi.org/10.1109/TSP.2017.2736494)
> [3] Julien Flamant, Pierre Chainais, Nicolas Le Bihan: “A complete framework for linear filtering of bivariate signals”, 2018; Accepted for publication in IEEE Transactions on Signal Processing; [arXiv:1802.02469](https://arxiv.org/abs/1802.02469)
These papers contains theoretical results and several applications that can be reproduced with this toolbox.
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.
Requirements
============
BiSPy works with python 3.5+.
Dependencies:
- [NumPy](http://www.numpy.org)
- [SciPy](https://www.scipy.org)
- [Matplotlib](http://matplotlib.org)
- [numpy-quaternion](https://github.com/moble/quaternion)
To install dependencies:
```shell
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
Clone this repository
```bash
git clone https://github.com/jflamant/bispy.git
cd bispy
```
And execute `setup.py`
```bash
pip install .
```
License
=======
This software is distributed under the [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.
Cite this work
==============
If you use this package for your own work, please consider citing it with this piece of BibTeX:
```bibtex
@misc{BiSPy,
title = {{BiSPy: an Open-Source Python project for processing bivariate signals}},
author = {Julien Flamant},
year = {2018},
url = {https://github.com/jflamant/bispy/},
howpublished = {Online at: \url{github.com/jflamant/bispy/}},
note = {Code at https://github.com/jflamant/bispy/, documentation at https://bispy.readthedocs.io/}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/jflamant/bispy",
"name": "bispy-polar",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "signal processing",
"author": "Julien Flamant",
"author_email": "julien.flamant@cnrs.fr",
"download_url": "https://files.pythonhosted.org/packages/16/ab/f628441e19fa1ed16e184f0e2329b4319287a15b987748b44d31e8d17d9c/bispy-polar-0.9.1.dev0.tar.gz",
"platform": null,
"description": "# BiSPy : Bivariate Signal Processing with Python\n\n[![Documentation](https://readthedocs.org/projects/bispy/badge/?style=default)](https://bispy.readthedocs.org)\n[![Build Status](https://travis-ci.org/jflamant/bispy.svg?branch=master)](https://travis-ci.org/jflamant/bispy)\n\nBiSPy 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.\n\n> [1] Julien Flamant, Nicolas Le Bihan, Pierre Chainais: \u201cTime-frequency analysis of bivariate signals\u201d, In press, Applied and Computational Harmonic Analysis, 2017; [arXiv:1609.0246](http://arxiv.org/abs/1609.02463), [doi:10.1016/j.acha.2017.05.007](https://doi.org/10.1016/j.acha.2017.05.007)\n\n> [2] Julien Flamant, Nicolas Le Bihan, Pierre Chainais: \u201cSpectral analysis of stationary random bivariate signals\u201d, 2017, IEEE Transactions on Signal Processing; [arXiv:1703.06417](http://arxiv.org/abs/1703.06417), [doi:10.1109/TSP.2017.2736494](https://doi.org/10.1109/TSP.2017.2736494)\n\n> [3] Julien Flamant, Pierre Chainais, Nicolas Le Bihan: \u201cA complete framework for linear filtering of bivariate signals\u201d, 2018; Accepted for publication in IEEE Transactions on Signal Processing; [arXiv:1802.02469](https://arxiv.org/abs/1802.02469)\n\nThese papers contains theoretical results and several applications that can be reproduced with this toolbox.\n\n\nThis 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.\n\nRequirements\n============\nBiSPy works with python 3.5+.\n\nDependencies:\n - [NumPy](http://www.numpy.org)\n - [SciPy](https://www.scipy.org)\n - [Matplotlib](http://matplotlib.org)\n - [numpy-quaternion](https://github.com/moble/quaternion)\n\nTo install dependencies:\n```shell\npip install numpy scipy matplotlib numpy-quaternion\n```\n\n[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).\n\n### Install from sources\n\nClone this repository\n\n```bash\ngit clone https://github.com/jflamant/bispy.git\ncd bispy\n```\n\nAnd execute `setup.py`\n\n```bash\npip install .\n```\n\nLicense\n=======\nThis software is distributed under the [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.\n\nCite this work\n==============\nIf you use this package for your own work, please consider citing it with this piece of BibTeX:\n\n```bibtex\n@misc{BiSPy,\n title = {{BiSPy: an Open-Source Python project for processing bivariate signals}},\n author = {Julien Flamant},\n year = {2018},\n url = {https://github.com/jflamant/bispy/},\n howpublished = {Online at: \\url{github.com/jflamant/bispy/}},\n note = {Code at https://github.com/jflamant/bispy/, documentation at https://bispy.readthedocs.io/}\n}\n```\n",
"bugtrack_url": null,
"license": "CeCIll",
"summary": "An open-source python framework for processing bivariate signals.",
"version": "0.9.1.dev0",
"project_urls": {
"Homepage": "https://github.com/jflamant/bispy"
},
"split_keywords": [
"signal",
"processing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ef8bb20e85328354fcbc15bc74495a3e6a586d3c001aebe4f7190542523e381",
"md5": "7523b9266b4518158601052c9e35c0c1",
"sha256": "a4a81a84dc2a7bd9f583bf99136d3703df69f67f8a72e90579bf7ef4bd3904b4"
},
"downloads": -1,
"filename": "bispy_polar-0.9.1.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7523b9266b4518158601052c9e35c0c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 30608,
"upload_time": "2023-06-03T22:13:07",
"upload_time_iso_8601": "2023-06-03T22:13:07.531360Z",
"url": "https://files.pythonhosted.org/packages/3e/f8/bb20e85328354fcbc15bc74495a3e6a586d3c001aebe4f7190542523e381/bispy_polar-0.9.1.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "16abf628441e19fa1ed16e184f0e2329b4319287a15b987748b44d31e8d17d9c",
"md5": "4555891e67edc97ad42036a8b4e5dba3",
"sha256": "4990d52aee64cfb8b9b691436a1d408073fa761245f4abcec6eab88201f739be"
},
"downloads": -1,
"filename": "bispy-polar-0.9.1.dev0.tar.gz",
"has_sig": false,
"md5_digest": "4555891e67edc97ad42036a8b4e5dba3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30525,
"upload_time": "2023-06-03T22:13:09",
"upload_time_iso_8601": "2023-06-03T22:13:09.044308Z",
"url": "https://files.pythonhosted.org/packages/16/ab/f628441e19fa1ed16e184f0e2329b4319287a15b987748b44d31e8d17d9c/bispy-polar-0.9.1.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-03 22:13:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jflamant",
"github_project": "bispy",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bispy-polar"
}