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.
md2html and pandoc2html formats produce output that is identical to pypublish command.
%%bash pweave -f md2html FIR_designp.pmd
Pweave has several options for LaTeX output, here is a demonstation of differences:
Latex with pygments syntax highlighting:¶
%%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:¶
%%bash pweave -f tex FIR_design_verb.texw pdflatex FIR_design_verb.tex
Latex with Minted package for syntax highlighting:¶
%%bash pweave -f texminted FIR_design_minted.texw pdflatex -shell-escape FIR_design_minted.tex
Using pygments directly from Pweave is much faster than using Minted separately.
%%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:
Using cell mark up:
%%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.
%%bash pweave -f md2html AR_yw.mdw pweave -f pandoc2latex AR_yw.mdw pdflatex AR_yw.tex
%%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:
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__
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)]