diplotocus 0.0.5__tar.gz → 0.3__tar.gz

diplotocus-0.3/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

diplotocus-0.3/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.mov
+*.ai
+GUI_web/.DS_Store
+.DS_Store
+diplotocus-docs/.DS_Store
+diplotocus-docs/Unnamed/
+tests
+.vscode
+Unnamed
+benchmark
+diplotocus.egg-info
+generate_doc_api.py
+dist
+src/diplotocus/INFO
+INFO

diplotocus-0.3/.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt

diplotocus-0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2026] [Tristan Boin]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

diplotocus-0.3/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: diplotocus
+Version: 0.3
+Summary: A python package to generate animations of matplotlib objects.
+Author-email: Tristan Boin <tristan.boin@obspm.fr>
+License-Expression: MIT
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: Matplotlib
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: svgpath2mpl
+Dynamic: license-file

diplotocus-0.3/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

diplotocus-0.3/docs/_static/force-light.css

@@ -0,0 +1,31 @@
+/* Force Furo to light mode and hide the theme toggle */
+:root,
+html,
+body,
+[data-theme] {
+  color-scheme: light !important;
+  background-color: var(--color-background-primary) !important;
+  color: var(--color-foreground-primary) !important;
+}
+
+html[data-theme="dark"], body[data-theme="dark"], [data-theme="dark"] {
+  color-scheme: light !important;
+}
+
+/* Hide the theme toggle controls so visitors cannot switch */
+.theme-toggle,
+.toggle-color-mode,
+.toggle-theme,
+.sd-theme-toggle,
+button[aria-label^="Toggle color"],
+button[aria-label*="theme"] {
+  display: none !important;
+}
+
+/* Ensure sidebar logo and notebook outputs remain visible */
+.content-icon-container{
+  display: block !important;
+}
+.nboutput, .output, .jp-OutputArea, .output_area {
+  display: block !important;
+}

diplotocus-0.3/docs/_static/force-light.js

@@ -0,0 +1,36 @@
+(function enforceLight() {
+  function setLight() {
+    try {
+      // prefer setting the document element attribute used by themes
+      document.documentElement.setAttribute('data-theme', 'light');
+      if (document.body) document.body.dataset.theme = 'light';
+      localStorage.setItem('theme', 'light');
+
+      // hide common theme toggle controls if present
+      var selectors = [
+        '.theme-toggle',
+        '.toggle-color-mode',
+        '.toggle-theme',
+        '.sd-theme-toggle',
+        'button[aria-label^="Toggle color"], button[aria-label*="theme"]'
+      ];
+      selectors.forEach(function(s) {
+        var el = document.querySelector(s);
+        if (el) el.style.display = 'none';
+      });
+    } catch (e) {
+      // ignore
+    }
+  }
+
+  setLight();
+  window.addEventListener('DOMContentLoaded', setLight);
+  window.addEventListener('load', setLight);
+  // Enforce repeatedly for a short while in case other scripts override
+  var tries = 0;
+  var id = setInterval(function() {
+    setLight();
+    tries += 1;
+    if (tries > 20) clearInterval(id);
+  }, 200);
+})();

diplotocus-0.3/docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: cb70878f0e1cea535f3a9cb2f95cac0e
+tags: 645f666f9bcd5a90fca523b33c5a78b7

diplotocus-0.3/docs/build/html/_sources/api/core.rst.txt

@@ -0,0 +1,119 @@
+Core Module
+===========
+
+Timeline
+--------
+
+.. autoclass:: diplotocus.core.Timeline
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Animations
+----------
+
+Base
+~~~~
+
+.. autoclass:: diplotocus.animations.Animation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Axis and figure animations
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: diplotocus.animations.axis_zoom
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.axis_limits
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.axis_move
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.axis_alpha
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.fig_width_ratio
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.fig_height_ratio
+   :members:
+   :undoc-members:
+
+Plot object animations
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: diplotocus.animations.scatter
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.plot
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.step
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.fill_between
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.fill_betweenx
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.axvline
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.axhline
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.errorbar
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.hist
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.hist2d
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.contourf
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.text
+   :members:
+   :undoc-members:
+
+.. autoclass:: diplotocus.animations.svg
+   :members:
+   :undoc-members:
+
+Easings
+-------
+
+.. automodule:: diplotocus.easings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+GUI
+===
+
+.. autoclass:: diplotocus.GUI.server.GUI
+   :members:
+   :undoc-members:
+   :show-inheritance:

diplotocus-0.3/docs/build/html/_sources/api/index.rst.txt

@@ -0,0 +1,9 @@
+API Reference
+==============
+
+This section documents the Python API of Diplotocus.
+
+.. toctree::
+   :maxdepth: 2
+
+   core

diplotocus-0.3/docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,87 @@
+Welcome to diplotocus' documentation!
+======================================
+
+.. raw:: html
+
+   <center>
+   <video width="700" height="394" autoplay muted playsinline>
+       <source src="_static/logo.mp4" type="video/mp4">
+   </video>
+   </center>
+
+**Diplotocus** is a python package designed to render animations of `matplotlib <https://matplotlib.org/>`_ objects, in a *timeline* style.
+
+Here's a quick example of the syntax of diplotocus:
+
+.. code-block:: python
+
+   import diplotocus as dpl
+   import numpy as np
+
+   #We define our Timeline, the object that handles all animations on our figure
+   tl = dpl.Timeline(xlim=(0,6*np.pi),ylim=(-1,1))
+
+   #We generate data points
+   x = np.linspace(0,6*np.pi,200)
+   y = np.cos(x)
+
+   #We create a plot() object
+   p = dpl.plot(x=x,y=y)
+
+   #We draw its data points sequentially
+   p.draw(duration=100)
+   tl.animate(p)
+
+   #We wait 25 frames
+   tl.wait(duration=25)
+
+   #We unzoom and move the axis to (0,0)
+   az = dpl.axis_zoom(zoom=0.5,duration=50)
+   am = dpl.axis_move(end_pos=(0,0),duration=50)
+   tl.animate((az,am))
+
+   #We hide the plot
+   p.hide(duration=100)
+   tl.animate(p)
+
+   #We render our video
+   tl.save_video(path='../_static/demo.mp4')
+
+.. raw:: html
+
+   <center>
+   <video width="640" height="360" autoplay loop muted playsinline>
+       <source src="_static/demo.mp4" type="video/mp4">
+   </video>
+   </center>
+
+**Diplotocus** also features a Web GUI that lets you put your animations together visually, in a timeline-like manner:
+
+.. image:: _static/Web_GUI.png
+   :width: 700
+   :target: notebooks/GUI
+
+Get started by :doc:`Installing Diplotocus <notebooks/installation>`, and follow the :doc:`Quick-Start guide <notebooks/quick-start>`.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Getting Started
+
+   notebooks/installation
+   notebooks/quick-start
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Library reference
+   
+   notebooks/timeline
+   notebooks/plot_objects
+   notebooks/animations
+   notebooks/easings
+   notebooks/GUI
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API Reference
+
+   api/index

diplotocus-0.3/docs/build/html/_sources/notebooks/GUI.ipynb.txt

@@ -0,0 +1,91 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "fc90d5b2",
+   "metadata": {},
+   "source": [
+    "# GUI\n",
+    "\n",
+    "**Diplotocus** features a GUI (Graphical User Interface):\n",
+    "\n",
+    "![](../_static/Web_GUI.png)\n",
+    "\n",
+    "When running diplotocus through this mode, you will make edit your animation through a local web page in your browser. This page communicates with a python server, which links the GUI and diplotocus objects in the background. Hence, everything you can do through python, you can do through the GUI, and vice versa.\n",
+    "\n",
+    "```{note}\n",
+    "\n",
+    "The datapoints used in any of the plot objects of your animations have to be created before launching the GUI, as they will be passed to the function that launches the GUI.\n",
+    "```\n",
+    "\n",
+    "```{eval-rst}\n",
+    ".. autoclass:: diplotocus.GUI\n",
+    "    :members:\n",
+    "    :noindex:\n",
+    "```\n",
+    "\n",
+    "Here's an example on how to launch the GUI:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8069c581",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import diplotocus as dpl\n",
+    "import numpy as np\n",
+    "\n",
+    "#We define our datapoints\n",
+    "x = np.linspace(0,2*np.pi,100)\n",
+    "y = np.cos(x)\n",
+    "\n",
+    "#We create our plot objects\n",
+    "a = dpl.scatter(x,y)\n",
+    "b = dpl.plot(x,y*2)\n",
+    "\n",
+    "#We create our timeline\n",
+    "tl = dpl.Timeline(xlim=(0,2*np.pi),ylim=(-1,1))\n",
+    "\n",
+    "#We pass our timeline, and a list of dictionaries of our plot objects,\n",
+    "#their display name, and any data that might be used by animations\n",
+    "GUI = dpl.GUI(\n",
+    "    timeline=tl,\n",
+    "    plot_objects=[\n",
+    "    {\n",
+    "        'name':'scatter',\n",
+    "        'object':a,\n",
+    "        'new_x':x,\n",
+    "        'new_y':y/2\n",
+    "    },\n",
+    "    {\n",
+    "        'name':'plot',\n",
+    "        'object':b\n",
+    "    }\n",
+    "])"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}