Skip to main content

Scientific reports with embedded python computations with reST, LaTeX or markdown

Project description

https://zenodo.org/badge/doi/10.5281/zenodo.44683.svg https://travis-ci.org/mpastell/Pweave.svg?branch=master https://coveralls.io/repos/github/mpastell/Pweave/badge.svg?branch=master

About Pweave

Pweave is a scientific report generator and a literate programming tool for Python. Pweave can capture the results and plots from data analysis and works well with NumPy, SciPy and matplotlib. It is able to run python code from source document and include the results and capture matplotlib plots in the output.

Pweave is good for creating reports, tutorials, presentations etc. with embedded python code It can also be used to make websites together with e.g. Sphinx or rest2web.

Features:

  • Python 3.4, 3.5 and 3.6 compatibility

  • Code is run using jupyter_client giving the possibility to run code using any installed kernel (including python2) via –kernel argument. Some chunk options only work for Python.

  • Support for IPython magics and rich output.

  • Produce reST, Sphinx, Latex, HTML and markdown (pandoc and leanpub) output from several input formats.

    • Noweb uses noweb syntax for separating code from documentation.
    • Markdown. Run code from markdown code blocks.
    • Script. Python script with special markup in comments.
  • Execute python code in the chunks and capture input and output to a report.

  • Use hidden code chunks, i.e. code is executed, but not printed in the output file.

  • Capture matplotlib graphics.

  • Evaluate inline code in documentation chunks marked using <% %> and <%= %>.

  • Cache all code and results from previous runs for fast report generation when you are only working with documentation. Inline code will be hidden in documentation mode.

  • Supports reST, LaTeX, HTML or markdown for document chunks

  • Publish reports from Python scripts. Similar to R markdown.

  • Run from command line or interpreter.

Install

From PyPi:

pip install --upgrade Pweave

with conda:

conda install -c conda-forge pweave

or download the source and run:

python setup.py install

Pweave documentation can be found from the website http://mpastell.com/pweave

Release Notes

See CHANGELOG.txt for changes in each release.

License information

See the file “LICENSE” for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Pweave, version 0.30.3
Filename, size File type Python version Upload date Hashes
Filename, size Pweave-0.30.3-py2.py3-none-any.whl (125.1 kB) File type Wheel Python version 3.6 Upload date Hashes View
Filename, size Pweave-0.30.3.tar.gz (2.2 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page