Pweave example gallery¶

Basic document: FIR filter design¶

This example demonstrates most basic chunk options, output and capturing figures and it is available in several formats.

Example in different formats.¶
Format	Source	Pweaved	HTML	PDF
md2html	`FIR_designp.pmd`		`open`
texpygments	`FIR_design_pygments.texw`	`open`		`open`
tex	`FIR_design_verb.texw`	`open`		`open`
texminted	`FIR_design_minted.texw`	`open`		`open`
rst	`FIR_design.rstw`	`open`	`open`
script	`FIR_design.py`		`open`	`open`
pandoc	`FIR_designp.pmd`	`open`	`open`

The commands used to process the examples from command line are shown below.

Markdown¶

HTML output¶

md2html and pandoc2html formats produce output that is identical to pypublish command.

FIR_designp.pmd, FIR_designp.html

%%bash
pweave -f md2html FIR_designp.pmd

To pandoc markdown¶

FIR_designp.pmd, FIR_designp.md , FIR_design_pandoc.html

%%bash
pweave -f pandoc FIR_designp.pmd
pandoc -s --mathjax FIR_designp.md -o FIR_design_pandoc.html

Latex¶

Pweave has several options for LaTeX output, here is a demonstation of differences:

Latex with pygments syntax highlighting:¶

FIR_design_pygments.texw, FIR_design_pygments.tex, FIR_design_pygments.pdf and with IPython shell FIR_design_pygments_ipy.pdf.

Notice that the first command creates the needed pygments.sty. See pygments docs for more info.

%%bash
pygmentize -f tex -S default > pygments.sty
pweave -f texpygments FIR_design_pygments.texw
pdflatex FIR_design_pygments.tex
pweave -s ipython -f texpygments FIR_design_pygments.texw
cp FIR_design_pygments.tex FIR_design_pygments_ipy.tex
pdflatex FIR_design_pygments_ipy.tex

Latex with verbatim output:¶

FIR_design_verb.texw, FIR_design_verb.tex, FIR_design_verb.pdf.

%%bash
pweave -f tex FIR_design_verb.texw
pdflatex FIR_design_verb.tex

Latex with Minted package for syntax highlighting:¶

FIR_design_minted.texw, FIR_design_minted.tex , FIR_design_minted.pdf .

%%bash
pweave -f texminted FIR_design_minted.texw
pdflatex -shell-escape FIR_design_minted.tex

Note

Using pygments directly from Pweave is much faster than using Minted separately.

reStructuredText¶

FIR_design.rstw, FIR_design.rst , FIR_design_rst.html.

%%bash
pweave FIR_design.rstw
rst2html.py FIR_design.rst FIR_design_rst.html

Published from script¶

You can publish documents directly using the pypublish command.

Using doxygen mark up:

FIR_design.py, FIR_design.html , FIR_design.pdf .

Using cell mark up:

FIR_design_cells.py, FIR_design_cells.html , FIR_design_cells.pdf .

%%bash
pypublish FIR_design.py
pypublish FIR_design_cells.py
pypublish -f pdf FIR_design.py
pypublish -f pdf FIR_design_cells.py

Splitting code to multiple chunks¶

This example shows how to split code between multiple chunks to write documentation within a class using complete chunk option.

AR_yw.mdw , AR_yw.html , AR_yw.pdf .

%%bash
pweave -f md2html AR_yw.mdw
pweave -f pandoc2latex AR_yw.mdw
pdflatex AR_yw.tex

Miscellaneous¶

Linear regression with Statsmodels: linear_regression.py, linear_regression.html

%%bash
pypublish linear_regression.py

About the gallery¶

This page is an executable document that be run using Pweave using IPython shell to run all examples using:

pweave index.rstw

The latest version of the examples with any required extra files are available from the Git repository in examples directory.

This gallery was created using:

import pweave
pweave.__version__

'0.30'

import sys
print(sys.version)

3.6.2 |Anaconda custom (64-bit)| (default, Jul 20 2017, 13:51:32)
[GCC 4.4.7 20120313 (Red Hat 4.4.7-1)]