onekiloparsec / voila-tufte

A Voilà dashboard template based on Tufte.css

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Version Conda Version

voila-tufte

voila-tufte is a custom Voilà template using Tufte.css in order to render Jupyter notebooks following the guidelines outlined in Edward Tufte works.


Voilà technology allows to turn Jupyter notebooks into standalone webapps. It allows the scientific community to share its work and current research combining the power of code (initially in Python, but today language-agnostic) with a narrative format offered by notebooks.

On the other hand, Edward Tufte has outlined long ago the fundamental principles regarding the quantitative display of information. To me, every scientist should have read Tufte books and gain the real sense of what "data plotting" really means.

Now, it's time to combine both.

However, Voilà process Jupyter notebooks into webapps. As of now, it is not possible to simply load a custom .css file into a Jupyter notebook. Hence, one must install custom templates to be able to do so. Hence this repository.

At some point, we hope to merge this work with voila-vuetify.

Installation

voila-tufte can be installed from PyPI

pip install voila-tufte

Usage

To use the tufte template, just pass --template=tufte to the voila command line:

voila --template tufte tufte_example.ipynb

Author

Cédric Foellmi, a.k.a. @onekiloparsec (website).
(Ph.D. in astrophysics, and former support astronomer at the European Southern Observatory in Chile).
I am the author of the app iObserve (for macOS (and formerly in [iOS/iPad]) and arcsecond.io and many other useful stuff for astronomers.

About

A Voilà dashboard template based on Tufte.css

License:Other


Languages

Language:Smarty 39.7%Language:CSS 31.8%Language:Python 9.7%Language:HTML 9.5%Language:Jupyter Notebook 9.4%