Metadata-Version: 2.1
Name: interactive-publishing
Version: 0.2.6
Summary: Templates and tools for creating interactive figures and interactive text for publishing in EPUB3/HTML5.
Home-page: https://nikolasibalic.github.io/Interactive-Publishing/
License: BSD-3-Clause license
Keywords: EPUB3,interactive publishing,explorable explanation,quantum state visualisation
Author: Nikola Sibalic
Author-email: nikolasibalic@physics.org
Requires-Python: >=3.9,<4.0
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: BSD License
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Education
Classifier: Topic :: Education :: Computer Aided Instruction (CAI)
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Dist: Pillow (>=9.4.0,<10.0.0)
Requires-Dist: appdirs (>=1.4.4,<2.0.0)
Requires-Dist: lxml (>=4.9.4,<5.0.0)
Requires-Dist: matplotlib (>=3.6.2,<4.0.0)
Requires-Dist: mkdocs-git-committers-plugin-2 (>=2.2.2,<3.0.0)
Requires-Dist: mkdocs-git-revision-date-localized-plugin (>=1.2.2,<2.0.0)
Requires-Dist: mkdocs-glightbox (>=0.3.5,<0.4.0)
Requires-Dist: mkdocs-material[imaging] (>9.4.8)
Requires-Dist: numpy (>=1.26.2,<2.0.0)
Requires-Dist: pngquant (>=1.0.7,<2.0.0)
Requires-Dist: pngquant-cli (>=2.17.0.post5,<3.0.0)
Requires-Dist: pyvista (>=0.43.1,<0.44.0)
Project-URL: Documentation, https://nikolasibalic.github.io/Interactive-Publishing/
Project-URL: Repository, https://github.com/nikolasibalic/Interactive-Publishing
Description-Content-Type: text/markdown

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](https://physicsworld.com/a/do-interactive-figures-help-physicists-to-communicate-their-science/).

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**](https://nikolasibalic.github.io/Interactive-Publishing/)

[![DOI](https://zenodo.org/badge/163100222.svg)](https://zenodo.org/badge/latestdoi/163100222)  [![PyPI version](https://badge.fury.io/py/Interactive-Publishing.svg)](https://badge.fury.io/py/Interactive-Publishing) 

---------


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```](/TangleKit) package from this repository 
for creating interactive text. That package is based on 
on slightly modified and updated open-source
[Tangle.js](http://worrydream.com/Tangle/)
library of [Bret Victor](http://worrydream.com/ExplorableExplanations/).

Interactive figures use Matplotlib Python package and [```ifigures```](/ifigures)
package from this repository which is based
on updated and modified version of 
[ipywidgets-static](https://github.com/jakevdp/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. 


