https://github.com/akaihola/jupyter_abc
This extension makes it easy to render ABC markup as graphical music notation in a Jupyter notebook.
https://github.com/akaihola/jupyter_abc
extension jupyter music notation notebook
Last synced: about 1 year ago
JSON representation
This extension makes it easy to render ABC markup as graphical music notation in a Jupyter notebook.
- Host: GitHub
- URL: https://github.com/akaihola/jupyter_abc
- Owner: akaihola
- License: other
- Created: 2018-07-22T21:20:46.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-12T00:02:18.000Z (over 7 years ago)
- Last Synced: 2025-04-02T06:39:49.473Z (about 1 year ago)
- Topics: extension, jupyter, music, notation, notebook
- Language: Python
- Size: 122 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.rst
Awesome Lists containing this project
README
================================================================
jupyter_abc: ABC music notation extension for Jupyter Notebook
================================================================
This extension makes it easy to render ABC_ markup as graphical music notation
in a Jupyter notebook.
For rendering, the extension uses the abcjs_ Javascript library
by Paul Rosen and Gregory Dyke.
Installing
==========
To install the extension, use ``pip`` or ``setup.py``::
cd /path/to/jupyter_abc
python setup.py install # with setup.py
pip install . # with pip
If you want to develop or debug the extension,
install it in development mode so changes are reflected immediately
without needing to re-install::
cd /path/to/jupyter_abc
python setup.py develop # with setup.py
pip install -e . # with pip
Usage
=====
To use the extension, start Jupyter in the same Python environment
in which you installed the extension::
jupyter notebook
Start a new notebook in which you load and use the extension:
.. code-block:: python
%load_ext jupyter_abc
.. code-block:: text
%%abc
%%score (R1 R2) (L)
V:R1
[cc']2 z ((3g/a/b/ [cc']2) z ((3g/a/b/ | [cc']2) z2 z2 z c | (c3 B d3 c) | (g4 f2) z2 |
V:R2
x8 | x8 | G8- | G6 z2 |
V:L clef=bass middle=d
[cc']2 z ((3g/a/b/ [cc']2) z ((3g/a/b/ | [cc']2) z2 z4 | ([d'f']4 [c'e']4) | [bd']6 z2 |
.. image:: jupiter.png
.. note:: Try out the above example interactively using the
`quickstart notebook`_ in the binder_ service.
.. _ABC: http://abcnotation.com/
.. _abcjs: https://abcjs.net/
.. _`quickstart notebook`: https://mybinder.org/v2/gh/akaihola/jupyter_abc/binder?filepath=examples%2Fquickstart.ipynb
.. _binder: https://mybinder.org/