======
Boreal
======
.. image:: https://img.shields.io/pypi/v/boreal.svg
:target: https://pypi.python.org/pypi/boreal
.. image:: https://img.shields.io/travis/gtzan/boreal.svg
:target: https://travis-ci.com/gtzan/boreal
.. image:: https://readthedocs.org/projects/boreal/badge/?version=latest
:target: https://boreal.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
.. image:: https://github.com/gtzan/boreal/blob/main/images/boreal_logo.png
**Bo**\ keh **Re**\ active **A**\ udio Widget **L**\ ibrary
* Free software: MIT license
* Documentation: https://boreal.readthedocs.io.
Boreal is a library for creating plots that react to audio while the
audio is playing. The reactive audio widgets can be used as part of a
stand-alone Bokeh application but the primary goal of the framework is
to support the exploratory coding process when using Jupyter notebooks
for audio research.
The library is designed to be extensible and supports the addition of
new audio reactive widgets as well as audio processors that extract
information from the underlying audio signal. Playback controls can be
used to play, pause, and seek the underlying audio and associated
visuals.
Installation
------------
**Building from source**
To build boreal from source try::
python setup.py build
Then to install::
python setup.py install
If all went well, you should be able to run the following command in Python::
import boreal
Get started
-----------
To see how Boreal works try the following notebook (also part of the package):
https://github.com/gtzan/boreal/blob/main/boreal/audio_widgets_notebook.ipynb
Features
--------
* Bokeh application for audio reactive plots
* Example audio widgets: time domain, spectrum, waveform envelope, circularEQ
* Support for both real-time computation of visuals as well as pre-computation
* Ability to use html audio for playback on a local machine when notebook
is hosted remotely
* Straighforward to add new audio widgets and audio processors
TODO
====
Boreal is under development and there is a lot of additinal work planned.
Some examples include:
* More audio widgets
* Better documentation
* Support for multi-channel audio
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.1.0 (2022-09-22)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/gtzan/boreal",
"name": "boreal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "boreal",
"author": "George Tzanetakis",
"author_email": "gtzan@cs.uvic.ca",
"download_url": "https://files.pythonhosted.org/packages/56/80/edca53ecdece2789744bb601a50b47479e6a2840c3ec5685b75a8cec5856/boreal-0.8.4.tar.gz",
"platform": null,
"description": "======\nBoreal\n======\n\n\n.. image:: https://img.shields.io/pypi/v/boreal.svg\n :target: https://pypi.python.org/pypi/boreal\n\n.. image:: https://img.shields.io/travis/gtzan/boreal.svg\n :target: https://travis-ci.com/gtzan/boreal\n\n.. image:: https://readthedocs.org/projects/boreal/badge/?version=latest\n :target: https://boreal.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n\n\n\n\n.. image:: https://github.com/gtzan/boreal/blob/main/images/boreal_logo.png\n\n\n\t \n**Bo**\\ keh **Re**\\ active **A**\\ udio Widget **L**\\ ibrary\n\n\n* Free software: MIT license\n* Documentation: https://boreal.readthedocs.io.\n\nBoreal is a library for creating plots that react to audio while the\naudio is playing. The reactive audio widgets can be used as part of a\nstand-alone Bokeh application but the primary goal of the framework is\nto support the exploratory coding process when using Jupyter notebooks\nfor audio research.\n\nThe library is designed to be extensible and supports the addition of\nnew audio reactive widgets as well as audio processors that extract\ninformation from the underlying audio signal. Playback controls can be\nused to play, pause, and seek the underlying audio and associated\nvisuals.\n\nInstallation\n------------\n\n**Building from source**\n\nTo build boreal from source try::\n\n python setup.py build\n\nThen to install::\n \n python setup.py install\n\nIf all went well, you should be able to run the following command in Python::\n \n import boreal \n\n\n\nGet started\n-----------\nTo see how Boreal works try the following notebook (also part of the package):\n\nhttps://github.com/gtzan/boreal/blob/main/boreal/audio_widgets_notebook.ipynb\n\n\n\n\n\nFeatures\n--------\n\n* Bokeh application for audio reactive plots \n* Example audio widgets: time domain, spectrum, waveform envelope, circularEQ\n* Support for both real-time computation of visuals as well as pre-computation\n* Ability to use html audio for playback on a local machine when notebook\n is hosted remotely \n* Straighforward to add new audio widgets and audio processors \n\nTODO\n====\n\nBoreal is under development and there is a lot of additinal work planned.\nSome examples include:\n\n* More audio widgets\n* Better documentation\n* Support for multi-channel audio \n \n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.1.0 (2022-09-22)\n------------------\n\n* First release on PyPI.\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Bokeh Reactive Audio Library",
"version": "0.8.4",
"project_urls": {
"Homepage": "https://github.com/gtzan/boreal"
},
"split_keywords": [
"boreal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "04d63800ab9aa3935222505177ddb463a18f307261ca7306d114d82845d5d04e",
"md5": "43c614c349b46974f65a3f4438f45550",
"sha256": "3c360a996395ecebf34cee58340a76fc45fbf6991b5ae088c5946f171f470c90"
},
"downloads": -1,
"filename": "boreal-0.8.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "43c614c349b46974f65a3f4438f45550",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 2414514,
"upload_time": "2023-06-20T18:53:17",
"upload_time_iso_8601": "2023-06-20T18:53:17.889942Z",
"url": "https://files.pythonhosted.org/packages/04/d6/3800ab9aa3935222505177ddb463a18f307261ca7306d114d82845d5d04e/boreal-0.8.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5680edca53ecdece2789744bb601a50b47479e6a2840c3ec5685b75a8cec5856",
"md5": "dcf74c160fd5eb2da69dded209c7c8ff",
"sha256": "09d03593554af913e1595c27ff64779bbaf659401a87cb9aa475a28dd6009042"
},
"downloads": -1,
"filename": "boreal-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "dcf74c160fd5eb2da69dded209c7c8ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2422653,
"upload_time": "2023-06-20T18:53:20",
"upload_time_iso_8601": "2023-06-20T18:53:20.573140Z",
"url": "https://files.pythonhosted.org/packages/56/80/edca53ecdece2789744bb601a50b47479e6a2840c3ec5685b75a8cec5856/boreal-0.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-20 18:53:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gtzan",
"github_project": "boreal",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "boreal"
}
JSON
