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.

Source Distribution

Pweave-0.30.1.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

Pweave-0.30.1-py2.py3-none-any.whl (125.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Pweave-0.30.1.tar.gz.

File metadata

  • Download URL: Pweave-0.30.1.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Pweave-0.30.1.tar.gz
Algorithm Hash digest
SHA256 323b96d2e90d2cebe62d4942933fc29807bdf0d2728236d55155b3b21615ef4a
MD5 d46ba2e1933285ed52e55d007ab4ec0d
BLAKE2b-256 1693a29e8909c3945ea7ee89cde5a0aa03d7004efc2d3020b867dae81045f9bc

See more details on using hashes here.

File details

Details for the file Pweave-0.30.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Pweave-0.30.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8cc5db767d5309a6bf7217a44ee46b488e94a705f94342d328df12da9dd9fbdf
MD5 338b95543a71ff70fba4148a99d79117
BLAKE2b-256 558f2b896872d3d1c2cc17407ecfc43ad8fdf0b4b82ccc28bcbb5ac1a16fc7c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page