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.
The commands used to process the examples from command line are shown below.
Pweave has several options for LaTeX output, here is a demonstation of differences:
Latex with pygments syntax highlighting:¶
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:¶
pweave -f tex FIR_design_verb.texw pdflatex FIR_design_verb.tex
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:
Using cell mark up:
pypublish FIR_design.py pypublish FIR_design_cells.py pypublish -f pdf FIR_design.py pypublish -f pdf FIR_design_cells.py
pweave -f pandoc FIR_design.mdw pandoc -s --mathjax FIR_design.md -o FIR_design_pandoc.html
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.
pweave -f md2html AR_yw.mdw pweave -f pandoc2latex AR_yw.mdw pdflatex AR_yw.tex
Octave and Matlab¶
Pweave also supports weaving Octave/Matlab documents similar to Python. The support is more limited, but it is still useful. See the example below for more info.
pweave -s octave -f pandoc octave_sample.mdw pandoc octave_sample.md -o octave_sample.pdf
If you have Matlab and “python-matlab-brigde” installed you can use -s matlab option.
New in version 0.23.
About the gallery¶
This page is an executable document that be run using Pweave using IPython shell to run all examples using:
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__ u'0.25' >>> import sys >>> print(sys.version) 2.7.11 |Continuum Analytics, Inc.| (default, Dec 6 2015, 18:08:32) [GCC 4.4.7 20120313 (Red Hat 4.4.7-1)]