notebooks

IPython notebooks

Requires

Sources

Either put a markdown file (.md) in src/, or a notebook file (.ipynb) in notebooks/.

Note that the first heading will get transformed into the title during LaTeX/PDF export.

Build

Run make all to convert markdown files into notebook files and run all notebooks, and generate PDFs.

Run make clean-all to clean all but the .md and .ipynb sources.

Run make all-auto to run make all automatically every second.

Citations

See the Tutorial on Managing citations in the IPython Notebook for inserting citations into a notebook.

Bibliography

A CiteULike group organizes all references. Run make bib to download the BibTeX file directly.

NOTE: You need to update the BibTeX file explicitly. It will not update when running just make.

Bibliography style

The bibliography style is REVTeX. The nbconvert template implements it according to http://tex.stackexchange.com/a/15691/30438

Workflow

Writing a new notebook in markdown

Create a new file from the template (recommended).

cp src/template.md src/newnotebook.md
vi src/newnotebook.md

Write a new notebook in your favorite editor, possibly using vim-ipython for connecting to an IPython kernel to execute code in the editor.
Running make-all converts the markdown file into a notebook file with notedown, and runs the notebook with runipy. It also exports the notebook into a PDF.

Editing an existing notebook

You may also create a new notebook in the notebooks/ folder, or copy an existing notebook here.

CAUTION: make will overwrite and/or delete any .ipynb file in the notebooks/ directory if there is a corresponding .md file in the src/ directory. Thus, always rename a notebook file generated from markdown before editing!

License

notebooks by Andreas Sorge is licensed under a Creative Commons Attribution 4.0 International License.

andsor / notebooks