jupyterthemes
Theme-ify your Jupyter Notebooks!
| Author | Version | Status | Demo |
|---|---|---|---|
| Kyle Dunovan |  |
 |
 |
plotting style
markdown/equations
pandas dataframes
command palette
oceans16 syntax
grade3 syntax
onedork syntax
chesterish syntax
Links
Requirements
- Python 2.7, 3.3, 3.4, 3.5, 3.6
- Jupyter (Anaconda recommended)
Install with pip
# install/upgrade to latest version
pip install --upgrade jupyterthemesKnown issues
- Depending on your system, browser, etc., you may need to empty your browser cache after installing a new theme (-t) or attempting to restore the default (-r) in order for those changes to take effect. (see discussion here)
- If emptying the cache doesn't work, you may need to start a new jupyter session or restart your browser (see discussion here)
- Some users have found that "jt" is not recognized after installing the pypi release (as shown above). Still trying to get to the bottom of this but apparently the following provides a temporary fix (see discussion here).
# uninstall any existing versions
pip uninstall jupyterthemes
# install from the github repo
pip install --user git+https://github.com/dunovank/jupyter-themes.git
Command Line Usage
usage: jt [-h] [-l] [-t THEME] [-f MONOFONT] [-fs MONOSIZE] [-nf NBFONT]
[-nfs NBFONTSIZE] [-tf TCFONT] [-tfs TCFONTSIZE] [-m MARGINS]
[-cursw CURSORWIDTH] [-cursc CURSORCOLOR] [-cellw CELLWIDTH]
[-lineh LINEHEIGHT] [-alt] [-vim] [-T] [-N] [-r]
Command Line Examples
# list available themes
# oceans16 | grade3 | chesterish | onedork | monokai | solarizedl
jt -l
# select theme...
jt -t chesterish
# restore default theme
# NOTE: Need to delete browser cache after running jt -r
# If this doesn't work, try starting a new notebook session.
jt -r
# toggle toolbar ON and notebook name ON
jt -t grade3 -T -N
# set code font to 'Roboto Mono' 12pt
# (see monospace font table below)
jt -t oceans16 -f roboto -fs 12
# set code font to Fira Mono, 11.5pt
# 3digit font-size gets converted into float (115-->11.5)
jt -t grade3 -f fira -fs 115
# set text-cell/markdown and notebook fonts
# (see sans-serif & serif font tables below)
jt -t onedork -tf georgiaserif -nf droidsans
# adjust cell width, line-height of codecells
jt -t chesterish -cellw 900 -lineh 170
# fix the container-margins on the intro page (defaults to 'auto')
jt -t onedork -m 200
# adjust cursor width (in px) and make cursor red (r)
# options: b (blue), o (orange), r (red), p (purple), g (green), x (font color)
jt -t grade3 -cursc r -cursw 5
# toggle toolbar ON and notebook name ON
jt -t grade3 -T -N
# choose alternate txt/markdown layout (-alt)
# and alternate cell prompt (narrow, no numbers)
jt -t grade3 -alt -altpSet Plotting Style (from within notebook)
jtplot.style() makes changes to matplotlib's rcParams dictionary so that figure aesthetics match those of a chosen jupyterthemes style. Note, these commands do not need to be re-run every time you generate a new plot, just once at the beginning of your notebook or whenever style changes are desired after that.
For instance, I include the following two lines in my ~/.ipython/profile_default/startup/startup.ipy file so this is done automatically whenever I open a new notebook:
# import jtplot submodule from jupyterthemes
from jupyterthemes import jtplot
# currently installed theme will be used to
# set plot style if no arguments provided
jtplot.style()Some additional examples for setting "context" (taken from seaborn) and controlling various figure properties...
# import jtplot
from jupyterthemes import jtplot
# you can select an alternative theme's plot style by name
# oceans16 | grade3 | chesterish | onedork | monokai | solarizedl
jtplot.style('onedork')
# set "context" (paper, notebook, talk, or poster)
# & font scale (scalar applied to labels, legend, etc.)
jtplot.style('grade3', context='paper', fscale=1.4)
# turn on X- and Y-axis tick marks (default=False)
# and turn off the axis grid lines (default=True)
jtplot.style(ticks=True, grid=False)
# set the default figure size
# x (length), y (height)
jtplot.figsize(x=6., y=5.)
# or just adjust the aspect ratio
# new_length = length * aspect
jtplot.figsize(aspect=1.2)
# fully reset matplotlib default rcParams
jtplot.reset()Additional package info
Description of Command Line options
| cl options | arg | default |
|---|---|---|
| Usage help | -h | -- |
| List Themes | -l | -- |
| Theme Name to Install | -t | -- |
| Code Font | -f | source |
| Code Font-Size | -fs | 11 |
| Notebook Font | -nf | exosans |
| Notebook Font Size | -nfs | 13 |
| Text/MD Cell Font | -tf | merriserif |
| Text/MD Cell Fontsize | -tfs | 13 |
| Intro Page Margins | -m | auto |
| Cell Width | -cellw | 980 |
| Line Height | -lineh | 170 |
| Cursor Width | -cursw | 2 |
| Cursor Color | -cursc | -- |
| Alt Text/MD Layout | -alt | -- |
| Alt Prompt Layout | -altp | -- |
| Style Vim NBExt* | -vim | -- |
| Toolbar Visible | -T | -- |
| Name & Logo Visible | -N | -- |
| Restore Default | -r | -- |
Monospace Fonts (code cells)
| -f arg | Monospace Font |
|---|---|
| anka | Anka/Coder |
| anonymous | Anonymous Pro |
| aurulent | Aurulent Sans Mono |
| bitstream | Bitstream Vera Sans Mono |
| bpmono | BPmono |
| code | Code New Roman |
| consolamono | Consolamono |
| cousine | Cousine |
| dejavu | DejaVu Sans Mono |
| droidmono | Droid Sans Mono |
| fira | Fira Mono |
| firacode | Fira Code |
| generic | Generic Mono |
| hack | Hack |
| inconsolata | Inconsolata-g |
| inputmono | Input Mono |
| liberation | Liberation Mono |
| meslo | Meslo |
| office | Office Code Pro |
| oxygen | Oxygen Mono |
| roboto | Roboto Mono |
| saxmono | saxMono |
| source | Source Code Pro |
| sourcemed | Source Code Pro Medium |
| ptmono | PT Mono |
| ubuntu | Ubuntu Mono |
Sans-Serif Fonts
| -nf/-tf arg | Sans-Serif Font |
|---|---|
| exosans | Exo_2 |
| opensans | Open Sans |
| droidsans | Droid Sans |
| latosans | Lato |
| ptsans | PT Sans |
| robotosans | Roboto |
| sourcesans | Source Sans Pro |
| amikosans | Amiko |
| nobilesans | Nobile |
| alegreyasans | Alegreya |
| armatasans | Armata |
| cambaysans | Cambay |
| catamaransans | Catamaran |
| franklinsans | Libre Franklin |
| frankruhlsans | Frank Ruhl |
| gothicsans | Carrois Gothic |
| gudeasans | Gudea |
| hindsans | Hind |
| jaldisans | Jaldi |
| makosans | Mako |
| merrisans | Merriweather Sans |
| mondasans | Monda |
| oxygensans | Oxygen Sans |
| pontanosans | Pontano Sans |
| puritansans | Puritan Sans |
| ralewaysans | Raleway |
Serif Fonts
| -nf/-tf arg | Serif Font |
|---|---|
| loraserif | Lora |
| andadaserif | Andada |
| arapeyserif | Arapey |
| ptserif | PT Serif |
| georgiaserif | Georgia |
| cardoserif | Cardo |
| crimsonserif | Crimson Text |
| droidserif | Droid Serif |
| ebserif | EB Garamond |
| merriserif | Merriweather |
| notoserif | Noto Serif |
| vesperserif | Vesper Libre |
| scopeserif | ScopeOne |
| sanchezserif | Sanchez |
| neutonserif | Neuton |
| rasaserif | Rasa |
| goudyserif | Sorts Mill Goudy |
| vollkornserif | Vollkorn |