Skip to main content

Interactive text and figures

This project provides quick starting point for anyone who wants to experiment with interactive text and figures in their electronic publications (EPUB3 / HTML5 + JavaScript). One possible reason why one would use interactive text and figures is to communicate many possible stories to the audience, instead of usual single story line. See Physics World blogpost.

Two templates and corresponding tools are provided. Tools generate HTML/Javascript output that can be seen in web-browsers and e-readers. Generated examples don't have any external dependencies that need to be downloaded from the Internet. They are completely self contained, and be seen on all devices (even without Internet access), and they can be simply included in interactive texts/books in EPUB3 format, as well as web-pages.

For detailed documentation and discussion of motivation and examples check here

DOI PyPI version


Note on implementation

Interactive text example implements simple calculations in JavaScript. More complex calculations should be precalculated and provided as look-up tables.

Interactive figures generate figures for all possible combinations of the input. Control JavaScripts then displays just images corresponding to selected combination of input parameters, while all other images are hidden. This can make files relatively large, but it allows their viewing on devices with minimal computational resources, like ereaders, and old phones.

License

Overall license is BSD-3-Clause as outlined included in LICENSE.md.

This project uses TangleKit package from this repository for creating interactive text. That package is based on on slightly modified and updated open-source Tangle.js library of Bret Victor.

Interactive figures use Matplotlib Python package and ifigures package from this repository which is based on updated and modified version of ipywidgets-static. Compared to original package, dependency on IPython is removed, Python 2 and 3 are supported now, and few bugs are fixed.

Licenses are inherited from the original projects mentioned above. They are permissive, and allow reuse, with or without modification, but for details check corresponding LICENSE files and code headers.

Metadata

Release files for interactive-publishing 0.2.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for interactive-publishing 0.2.8
File Size Uploaded Provenance Actions
interactive_publishing-0.2.8.tar.gz 28.4 kB Without provenance Details for interactive_publishing-0.2.8.tar.gz

Release files / interactive_publishing-0.2.8.tar.gz

Download URL interactive_publishing-0.2.8.tar.gz
Size 28.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3f0aa454c47945ce99358438a61aefe17a9cc4fd584a33bbd1f8754ded8e05b0
BLAKE2b-256 checksum
How to use checksums
be24a94a9e45597ec93ba8dc40f45dcb454d3688cb46d84fd13a188bfe35d8be
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.3

Security for interactive-publishing 0.2.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page