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.3.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for Pweave-0.30.3.tar.gz
Algorithm Hash digest
SHA256 5e5298d90e06414a01f48e0d6aa4c36a70c5f223d929f2a9c7e2d388451c7357
MD5 6c6d0df971527b8aa0686aee3985c7c7
BLAKE2b-256 4d191d26e59f8928592062cfd4cd40084285be770b3a4735fff2aa38b97d1aaf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for Pweave-0.30.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 60cf8de680084b5423caa3a2131d4ff981c236f12f84f9d969a41f6632a44165
MD5 f646d13d9224856078b2f3e71e6b22d7
BLAKE2b-256 ea223f6f05c64e24b8725af568ba4181883fb74785f91a64e5452f7ad2537e5f

See more details on using hashes here.

Provenance

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