A workflow for creating and editing publication ready scientific reports, from one or more Jupyter Notebooks
Project description
IPyPublish
A program for creating and editing publication ready scientific reports and presentations, from one or more Jupyter Notebooks.
Documentation: ipypublish.readthedocs.io
Attention: A major API improvement occurred in
v0.7.0. This has not changed the general user interface, but anyone using custom converter plugins will be required to update them (see Plugin Conversion)
For an example of the potential input/output, see: Example.ipynb, Example.pdf, Example.html and Example.slides.html.
Or, for a practical example of the ipypublish capability, see these documents on Atomic 3D Visualisation: Notebook, PDF, HTML or Reveal.JS slideshow.
Design Philosophy
In essence, the dream is to have the ultimate hybrid of Jupyter Notebook, WYSIWYG editor (e.g. MS Word) and document preparation system (e.g. TexMaker), being able to:
- Dynamically (and reproducibly) explore data, run code and output the results
- Dynamically edit and visualise the basic components of the document (text, math, figures, tables, references, citations, etc).
- Have precise control over what elements are output to the final document and how they are layed out and typeset.
- Also be able to output the same source document to different layouts and formats (pdf, html,presentation slides, etc).
Workflow
- Create a notebook with some content!
- optionally create a .bib file and external images
- Adjust the notebook and cell metadata.
- install ipypublish and run the
nbpublishfor either the specific notebook, or a folder containing multiple notebooks. - A converted folder will be created, into which final
.tex.pdfand.htmlfiles will be output, named by the notebook or folder input
The default latex template outputs all markdown cells (unless tagged latex_ignore), and then only code and output cells with latex metadata tags.
See Example.ipynb, Example.pdf,
Example.html and Example.slides.html for examples of the potential input and output.
See the project site for more info!
Acknowledgements
IPyPublish is built as an extension to nbconvert.
I also took strong influence from:
- Julius Schulz
- Dan Mackinlay
- Notebook concatination was adapted from nbconvert issue#253
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ipypublish-0.10.12.tar.gz.
File metadata
- Download URL: ipypublish-0.10.12.tar.gz
- Upload date:
- Size: 215.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 01c094d57bfee349b44f32922b9f843b36e137955f2a852507a5c04479af39e9 |
|
| MD5 | 347ae2971dbfaecd95f0a48156cd5f1e |
|
| BLAKE2b-256 | 41d74474b49269db9af24e852e7bcfd27fefa79ff97a3014c9401d970bf12f4f |
File details
Details for the file ipypublish-0.10.12-py2.py3-none-any.whl.
File metadata
- Download URL: ipypublish-0.10.12-py2.py3-none-any.whl
- Upload date:
- Size: 292.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 69e9e7eb45e25307680eadda2f206cb2816b2e855213bcfeef4239767e1b162c |
|
| MD5 | 41f80ed1e5a9818e5612f558b7e3f3b8 |
|
| BLAKE2b-256 | add023ee388ccb6e6e46a0d141935c8c18b759a935b3b6d78ef6eef4b3c5aa01 |
