diplotocus 0.3.3__tar.gz → 0.3.5__tar.gz

{diplotocus-0.3.3 → diplotocus-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diplotocus
-Version: 0.3.3
+Version: 0.3.5
 Summary: A python package to generate animations of matplotlib objects.
 Author-email: Tristan Boin <tristan.boin@obspm.fr>
 License-Expression: MIT
@@ -19,7 +19,7 @@ Dynamic: license-file
   <img width="300" src="https://github.com/titanbin/Diplotocus/blob/main/logo.png?raw=true" />
 </p>
 
-[![Documentation](https://img.shields.io/badge/docs-passing-success)](https://diplotocus.readthedocs.io) [![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/titanbin/Diplotocus/blob/main/LICENSEE) [![License](https://img.shields.io/pypi/v/diplotocus?color=blue)](https://pypi.org/project/diplotocus/)
+[![Documentation](https://img.shields.io/badge/docs-passing-success)](https://diplotocus.readthedocs.io) [![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/titanbin/Diplotocus/blob/main/LICENSE) [![License](https://img.shields.io/pypi/v/diplotocus?color=blue)](https://pypi.org/project/diplotocus/)
 
 **Diplotocus** is a python package designed to render animations of matplotlib objects, in a *timeline* style.
 

{diplotocus-0.3.3 → diplotocus-0.3.5}/docs/source/api/core.rst

@@ -15,7 +15,7 @@ Animations
 Base
 ~~~~
 
-.. autoclass:: diplotocus.animations.Animation
+.. autoclass:: diplotocus.animations.plotObject
    :members:
    :undoc-members:
    :show-inheritance:

{diplotocus-0.3.3 → diplotocus-0.3.5}/docs/source/index.rst

@@ -78,6 +78,7 @@ Get started by :doc:`Installing Diplotocus <notebooks/installation>`, and follow
    notebooks/plot_objects
    notebooks/animations
    notebooks/easings
+   notebooks/projects
    notebooks/GUI
 
 .. toctree::

{diplotocus-0.3.3 → diplotocus-0.3.5}/docs/source/notebooks/animations.ipynb

@@ -14,7 +14,14 @@
     "\n",
     "Once animations have been set on plot objects, they have to be rendered via `Timeline.animate(plot_objs)` ([See Timeline](timeline)).\n",
     "\n",
-    "## Animations of plot objects"
+    "## Animations of plot objects\n",
+    "\n",
+    "### Plot\n",
+    "\n",
+    "```{eval-rst}\n",
+    ".. automethod:: diplotocus.animations.plotObject.plot\n",
+    "    :noindex:\n",
+    "```"
    ]
   },
   {
@@ -25,7 +32,7 @@
     "### Translate\n",
     "\n",
     "```{eval-rst}\n",
-    ".. automethod:: diplotocus.animations.Animation.translate\n",
+    ".. automethod:: diplotocus.animations.plotObject.translate\n",
     "    :noindex:\n",
     "```"
    ]
@@ -102,7 +109,7 @@
     "### Rotate\n",
     "\n",
     "```{eval-rst}\n",
-    ".. automethod:: diplotocus.animations.Animation.rotate\n",
+    ".. automethod:: diplotocus.animations.plotObject.rotate\n",
     "    :noindex:\n",
     "```"
    ]
@@ -179,7 +186,7 @@
     "### Scale\n",
     "\n",
     "```{eval-rst}\n",
-    ".. automethod:: diplotocus.animations.Animation.scale\n",
+    ".. automethod:: diplotocus.animations.plotObject.scale\n",
     "    :noindex:\n",
     "```"
    ]
@@ -256,12 +263,12 @@
     "### Tween\n",
     "\n",
     "```{eval-rst}\n",
-    ".. automethod:: diplotocus.animations.Animation.tween\n",
+    ".. automethod:: diplotocus.animations.plotObject.tween\n",
     "    :noindex:\n",
     "```\n",
     "\n",
     "```{eval-rst}\n",
-    ".. automethod:: diplotocus.animations.Animation.tweens\n",
+    ".. automethod:: diplotocus.animations.plotObject.tweens\n",
     "    :noindex:\n",
     "```\n",
     "\n",
@@ -345,7 +352,7 @@
     "### Morph\n",
     "\n",
     "```{eval-rst}\n",
-    ".. automethod:: diplotocus.animations.Animation.morph\n",
+    ".. automethod:: diplotocus.animations.plotObject.morph\n",
     "    :noindex:\n",
     "```"
    ]
@@ -426,7 +433,7 @@
     "### Draw\n",
     "\n",
     "```{eval-rst}\n",
-    ".. automethod:: diplotocus.animations.Animation.draw\n",
+    ".. automethod:: diplotocus.animations.plotObject.draw\n",
     "    :noindex:\n",
     "```"
    ]
@@ -504,7 +511,7 @@
     "### Sequence\n",
     "\n",
     "```{eval-rst}\n",
-    ".. automethod:: diplotocus.animations.Animation.sequence\n",
+    ".. automethod:: diplotocus.animations.plotObject.sequence\n",
     "    :noindex:\n",
     "```"
    ]

{diplotocus-0.3.3 → diplotocus-0.3.5}/readme.md

@@ -2,7 +2,7 @@
   <img width="300" src="https://github.com/titanbin/Diplotocus/blob/main/logo.png?raw=true" />
 </p>
 
-[![Documentation](https://img.shields.io/badge/docs-passing-success)](https://diplotocus.readthedocs.io) [![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/titanbin/Diplotocus/blob/main/LICENSEE) [![License](https://img.shields.io/pypi/v/diplotocus?color=blue)](https://pypi.org/project/diplotocus/)
+[![Documentation](https://img.shields.io/badge/docs-passing-success)](https://diplotocus.readthedocs.io) [![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/titanbin/Diplotocus/blob/main/LICENSE) [![License](https://img.shields.io/pypi/v/diplotocus?color=blue)](https://pypi.org/project/diplotocus/)
 
 **Diplotocus** is a python package designed to render animations of matplotlib objects, in a *timeline* style.
 

diplotocus-0.3.5/src/diplotocus/_version.py

@@ -0,0 +1 @@
+__version__ = "0.3.5"

{diplotocus-0.3.3 → diplotocus-0.3.5}/src/diplotocus/animations.py

@@ -32,16 +32,12 @@ def to_np_array(obj):
         obj = np.ravel(obj)
     return obj
 
-class Animation:
+class plotObject:
     """
-    A parent Animation object for all plotting objects.
+    A parent plotObject object for all plotting objects.
 
     Parameters
     ----------
-    duration : float
-        Duration of the animation
-    delay : float, default=0
-        Delay before starting
     easing : callable, optional
         Easing function
     axis : matplotlib.axes.Axes, optional
@@ -332,6 +328,29 @@ class Animation:
                 ends[i] = list(mpl.colors.to_rgba_array(ends[i])[0])
         return properties,starts,ends
 
+    def plot(self,duration,delay=0,easing=None,persistent=True):
+        """Plot the plot object as-is without animation.
+
+        Parameters
+        ----------
+        duration : float
+            the number of frames the animation runs from.
+        delay : float, default=0
+            the number of frames after what the animation starts playing.
+        easing : callable, optional
+            the easing used for this animation. If None, a linear easing is applied.
+        """
+        self.anims.append({
+            'name':'plot',
+            'duration':duration,
+            'delay':delay,
+            'easing':easing,
+            'persistent':persistent,
+            'played':False
+        })
+        self.compute_timings()
+        return self
+
     def tween(self,property,start,end,duration,delay=0,easing=None,persistent=True):
         """Animate a change in a property of the plot object.
 
@@ -839,7 +858,7 @@ class Animation:
             cy = 0.5 * (bbox.y0 + bbox.y1)
         return (cx,cy)
 
-class axis_zoom(Animation):
+class axis_zoom(plotObject):
     """
     Zooms into the axis given a zoom value.
 
@@ -855,11 +874,6 @@ class axis_zoom(Animation):
         Easing function
     axis : matplotlib.axes.Axes, optional
         Axis to plot on
-
-    Example
-    --------
-    Zoom 2 times in 100 frames:
-        >>> axis_zoom(zoom=2,duration=100)
     """
     def __init__(self,zoom,duration,delay=0,easing=None,axis=None,*args,**kwargs):
         super().__init__(axis=axis,*args, **kwargs)
@@ -896,7 +910,7 @@ class axis_zoom(Animation):
         self.axis.set_xlim(x_range[0],x_range[1])
         self.axis.set_ylim(y_range[0],y_range[1])
 
-class axis_limits(Animation):
+class axis_limits(plotObject):
     """
     Reframe axis to the given limits (on the x-axis, y-axis or both depending on passed arguments)
 
@@ -914,11 +928,6 @@ class axis_limits(Animation):
         Easing function
     axis : matplotlib.axes.Axes, optional
         Axis to plot on
-
-    Example
-    --------
-    Reframe x-axis to limits [0-2] in 100 frames:
-        >>> axis_limits(xlim=(0,2),duration=100)
     """
     def __init__(self,duration,xlim=None,ylim=None,delay=0,easing=None,axis=None,*args,**kwargs):
         if xlim is None and ylim is None:
@@ -957,7 +966,7 @@ class axis_limits(Animation):
             ylim_top    = anim['start_ylim'][1] + (anim['ylim'][1] - anim['start_ylim'][1])*t
             self.axis.set_ylim(ylim_bottom,ylim_top)
 
-class axis_move(Animation):
+class axis_move(plotObject):
     """
     Move the center of the axis to a given position.
 
@@ -973,11 +982,6 @@ class axis_move(Animation):
         Easing function
     axis : matplotlib.axes.Axes, optional
         Axis to plot on
-
-    Example
-    --------
-    Recenter the axis to (-1,-1) in 100 frames:
-        >>> axis_move(pos=(-1,-1),duration=100)
     """
     def __init__(self,end_pos,duration,start_pos=None,delay=0,easing=None,axis=None,*args,**kwargs):
         super().__init__(axis=axis,*args, **kwargs)
@@ -1013,7 +1017,7 @@ class axis_move(Animation):
         self.axis.set_xlim(pos_x-width/2,pos_x+width/2)
         self.axis.set_ylim(pos_y-height/2,pos_y+height/2)
 
-class axis_alpha(Animation):
+class axis_alpha(plotObject):
     """
     Change the opacity of the axis.
 
@@ -1031,11 +1035,6 @@ class axis_alpha(Animation):
         Easing function
     axis : matplotlib.axes.Axes, optional
         Axis to plot on
-
-    Example
-    --------
-    Make the axis appear in 100 frames
-        >>> axis_alpha(start_alpha=0,end_alpha=1,duration=100)
     """
     def __init__(self,start_alpha,end_alpha,duration,delay=0,alpha_objs=True,easing=None,axis=None,*args,**kwargs):
         super().__init__(axis=axis,*args, **kwargs)
@@ -1099,7 +1098,7 @@ class axis_alpha(Animation):
                 for txt in leg.get_texts():
                     txt.set_alpha(alpha)
 
-class fig_width_ratio(Animation):
+class fig_width_ratio(plotObject):
     """
     Resize subplots' widths.
 
@@ -1117,11 +1116,6 @@ class fig_width_ratio(Animation):
         Easing function
     axis : matplotlib.axes.Axes, optional
         Axis to plot on
-
-    Example
-    --------
-    Resize 2 subplots from equal widths to a ratio of 2:1 in 100 frames:
-        >>> fig_width_ratio(start_widths=(1,1),end_widths=(1,2),duration=100)
     """
     def __init__(self,start_widths,end_widths,duration,delay=0,easing=None,axis=None,*args,**kwargs):
         super().__init__(axis=axis,*args, **kwargs)
@@ -1175,7 +1169,7 @@ class fig_width_ratio(Animation):
                     if row[i].axison == False:
                         row[i].set_axis_on()
 
-class fig_height_ratio(Animation):
+class fig_height_ratio(plotObject):
     """
     Resize subplots' heights.
 
@@ -1193,11 +1187,6 @@ class fig_height_ratio(Animation):
         Easing function
     axis : matplotlib.axes.Axes, optional
         Axis to plot on
-
-    Example
-    --------
-    Resize 2 subplots from equal heights to a ratio of 2:1 in 100 frames:
-        >>> fig_width_ratio(start_heights=(1,1),end_heights=(1,2),duration=100)
     """
     def __init__(self,start_heights,end_heights,duration,delay=0,easing=None,axis=None,*args,**kwargs):
         super().__init__(axis=axis,*args, **kwargs)
@@ -1251,7 +1240,7 @@ class fig_height_ratio(Animation):
                     if column[i].axison == False:
                         column[i].set_axis_on()
 
-class scatter(Animation):
+class scatter(plotObject):
     """
     A scatter plot of *y* vs. *x* with varying marker size and/or color.
 
@@ -1481,7 +1470,7 @@ class scatter(Animation):
                 kwargs['c'] = c.reshape(1,-1)
         self.obj = self.axis.scatter(data_x,data_y,**kwargs)
 
-class plot(Animation):
+class plot(plotObject):
     """
     Plot y versus x as lines and/or markers.
 
@@ -1797,7 +1786,7 @@ class plot(Animation):
             kwargs['alpha'] = kwargs['alpha'][0]
         self.obj = self.axis.plot(data_x,data_y,**kwargs)
 
-class step(Animation):
+class step(plotObject):
     """
     Make a step plot.
 
@@ -1877,7 +1866,7 @@ class step(Animation):
         
         self.obj = self.axis.step(data_x,data_y,**kwargs)
 
-class fill_between(Animation):
+class fill_between(plotObject):
     """
     Fill the area between two horizontal curves.
 
@@ -2045,7 +2034,7 @@ class fill_between(Animation):
     def function(self,data_x,data_y,x,kwargs):
         self.obj = self.axis.fill_between(x=data_x,**kwargs)
 
-class fill_betweenx(Animation):
+class fill_betweenx(plotObject):
     """
     Fill the area between two vertical curves.
 
@@ -2213,7 +2202,7 @@ class fill_betweenx(Animation):
     def function(self,data_x,data_y,x,kwargs):
         self.obj = self.axis.fill_betweenx(y=data_x,**kwargs)
     
-class axvline(Animation):
+class axvline(plotObject):
     """
     Add a vertical line spanning the whole or fraction of the Axes.
 
@@ -2352,7 +2341,7 @@ class axvline(Animation):
         if len(data_x) > 0:
             self.obj = [self.axis.axvline(data_x,**kwargs)]
 
-class axhline(Animation):
+class axhline(plotObject):
     """
     Add a horizontal line spanning the whole or fraction of the Axes.
 
@@ -2430,7 +2419,7 @@ class axhline(Animation):
         if len(data_x) > 0:
             self.obj = [self.axis.axhline(data_x,**kwargs)]
 
-class errorbar(Animation):
+class errorbar(plotObject):
     """
     Plot y versus x as lines and/or markers with attached errorbars.
 
@@ -2667,7 +2656,7 @@ class errorbar(Animation):
         obj = [obj.lines[0]] + list(obj.lines[1]) + list(obj.lines[2])
         self.obj = obj
 
-class hist(Animation):
+class hist(plotObject):
     """
     Compute and plot a histogram.
 
@@ -2922,7 +2911,7 @@ class hist(Animation):
         
         h,edges,self.obj = self.axis.hist(data_x,**kwargs)
 
-class hist2d(Animation):
+class hist2d(plotObject):
     """
     Make a 2D histogram plot.
 
@@ -3079,7 +3068,7 @@ class hist2d(Animation):
         self.axis.set_xlim(old_xlim)
         self.axis.set_ylim(old_ylim)
 
-class contourf(Animation):
+class contourf(plotObject):
     """
     Plot filled contours.
 
@@ -3428,14 +3417,14 @@ class contourf(Animation):
         self.axis.set_xlim(old_xlim)
         self.axis.set_ylim(old_ylim)
 
-class text(Animation):
+class text(plotObject):
     """
     Add text to the Axes.
 
     Add the text *s* to the Axes at location *x*, *y* in data coordinates,
     with a default ``horizontalalignment`` on the ``left`` and
     ``verticalalignment`` at the ``baseline``. 
-    
+
     Parameters
     ----------
     x, y : float
@@ -3607,7 +3596,7 @@ class text(Animation):
         self.path = patch.get_path()
         self.obj = patch
 
-class svg(Animation):
+class svg(plotObject):
     """A vector SVG object.
 
     Parameters

{diplotocus-0.3.3 → diplotocus-0.3.5}/src/diplotocus/core.py

@@ -59,11 +59,22 @@ def status_message(start_msg, end_msg):
 #----------------------------------------------
 
 def load_project(path):
+    """Load a project.
+
+    Parameters
+    ----------
+    path : str
+        the path to the project file.
+
+    Returns
+    ----------
+    (Timeline,list of plot objects)
+    """
     tl = pickle.load(open(path, 'rb'))
-    animations = tl.animations
+    plot_objects = tl.plot_objects
     tl.x = 0
     tl.clean_all()
-    return tl,animations
+    return tl,plot_objects
 
 class Timeline:
     """Create and manage an animation timeline.
@@ -117,11 +128,11 @@ class Timeline:
             self.ax = np.array(self.ax)
         if isinstance(self.ax,np.ndarray):
             if isinstance(self.ax[0],np.ndarray):
-                self.main_axis = self.ax[0,0]
+                self.set_main_axis(self.ax[0,0])
             else:
-                self.main_axis = self.ax[0]
+                self.set_main_axis(self.ax[0])
         else:
-            self.main_axis = self.ax
+            self.set_main_axis(self.ax)
         if xlim is not None:
             self.main_axis.set_xlim(*xlim)
         if ylim is not None:
@@ -133,7 +144,7 @@ class Timeline:
         self.x = 0
         self.timeline_str = ''
         self.transparent = transparent
-        self.animations = []
+        self.plot_objects = []
         if in_notebook() == False:
             namespace = sys._getframe(1).f_globals['__file__']
             self.full_path = '/'.join(namespace.split('/')[:-1])
@@ -142,7 +153,24 @@ class Timeline:
         if noaxis:
             self.main_axis.set_axis_off()
 
+    def set_main_axis(self,ax):
+        """Set the default axis to plot objects on
+
+        Parameters
+        ----------
+        ax : matplotlib.axes.Axes, optional
+            Axis to set as default
+        """
+        self.main_axis = ax
+
     def set_axis_color(self,color):
+        """Set the color of axes
+
+        Parameters
+        ----------
+        color : color or array-like, optional
+            The color to set the axes
+        """
         if isinstance(self.ax,np.ndarray) == False:
             axes = (self.ax,)
         else:
@@ -175,24 +203,24 @@ class Timeline:
                     if p.get_animated():
                         p.remove()
 
-    def plot(self,animations,x=0,easing=None,debug=False):
-        if isinstance(animations,Animation):
-            animations = (animations,)
+    def plot(self,plot_objects,x=0,easing=None,debug=False):
+        if isinstance(plot_objects,plotObject):
+            plot_objects = (plot_objects,)
 
-        for animation in animations:
-            if animation.obj is not None and ((animation.x_min <= x < animation.x_max) or (x >= animation.x_max and animation.persistent == False)):
-                objects = np.ravel(animation.obj)
+        for plot_object in plot_objects:
+            if plot_object.obj is not None and ((plot_object.x_min <= x < plot_object.x_max) or (x >= plot_object.x_max and plot_object.persistent == False)):
+                objects = np.ravel(plot_object.obj)
                 for obj in objects:
                     try:
                         obj.remove()
                     except:
                         pass
             
-            animation.initialize(self)
+            plot_object.initialize(self)
             #only plot if within an anim or if last one is persistent
             last_anim = None
             closest_dist = np.inf
-            for anim in animation.anims:
+            for anim in plot_object.anims:
                 anim_x_max = anim['duration']+anim['delay']
                 if anim_x_max > x:
                     continue
@@ -204,19 +232,19 @@ class Timeline:
             if last_anim is not None:
                 is_within_anim = last_anim['persistent'] == True
             if is_within_anim == False:
-                for anim in animation.anims:
+                for anim in plot_object.anims:
                     anim_x_min = anim['delay']
                     anim_x_max = anim['duration']+anim['delay']
                     if anim_x_min <= x < anim_x_max:
                         is_within_anim = True
                         break
             if is_within_anim:
-                animation.apply(x,easing)
+                plot_object.apply(x,easing)
         prev_x = self.x
         self.x = x
         self.save_plot(debug)
-        for animation in animations:
-            animation.clean(x,clear_anims=False)
+        for plot_object in plot_objects:
+            plot_object.clean(x,clear_anims=False)
         self.x = prev_x
 
     def animate(self,plot_objects,easing=None,debug=False):
@@ -224,14 +252,14 @@ class Timeline:
 
         Parameters
         ----------
-        plot_objects : Animation or sequence of Animation
+        plot_objects : plotObject or sequence of plotObject
             a single plot object (e.g. `scatter`, `plot`, `hist`...) or a list of plot objects.
         easing : easing
             an easing override used while rendering.
         debug : bool
             if True, skip writing frame images to disk.
         """
-        if isinstance(plot_objects,Animation):
+        if isinstance(plot_objects,plotObject):
             plot_objects = (plot_objects,)
         self.animations = deepcopy(np.array(plot_objects))
         
@@ -250,11 +278,14 @@ class Timeline:
             loop = tqdm(loop)
 
         for x in loop:
-            self.plot(animations=plot_objects,x=x,easing=easing,debug=debug)
+            self.plot(plot_objects=plot_objects,x=x,easing=easing,debug=debug)
         for animation in plot_objects:
             for anim in animation.anims:
                 anim['played'] = True
         self.x = x_max
+        for animation in plot_objects:
+            if self.x >= animation.x_max and animation.persistent == False:
+                animation.clean(animation.x_max - 2, clear_anims=False)
 
     def wait(self,duration):
         """Pause the animation for a number of frames.
@@ -354,5 +385,12 @@ class Timeline:
             """.format(video_fn,rand_id)))
     
     def save_project(self,path):
+        """Save the current Timeline and associated plot objects to a project file.
+
+        Parameters
+        ----------
+        path : str
+            The path to save the project file to.
+        """
         with open(path, 'wb') as f:
             pickle.dump(self, f)

{diplotocus-0.3.3 → diplotocus-0.3.5}/src/diplotocus.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diplotocus
-Version: 0.3.3
+Version: 0.3.5
 Summary: A python package to generate animations of matplotlib objects.
 Author-email: Tristan Boin <tristan.boin@obspm.fr>
 License-Expression: MIT
@@ -19,7 +19,7 @@ Dynamic: license-file
   <img width="300" src="https://github.com/titanbin/Diplotocus/blob/main/logo.png?raw=true" />
 </p>
 
-[![Documentation](https://img.shields.io/badge/docs-passing-success)](https://diplotocus.readthedocs.io) [![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/titanbin/Diplotocus/blob/main/LICENSEE) [![License](https://img.shields.io/pypi/v/diplotocus?color=blue)](https://pypi.org/project/diplotocus/)
+[![Documentation](https://img.shields.io/badge/docs-passing-success)](https://diplotocus.readthedocs.io) [![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/titanbin/Diplotocus/blob/main/LICENSE) [![License](https://img.shields.io/pypi/v/diplotocus?color=blue)](https://pypi.org/project/diplotocus/)
 
 **Diplotocus** is a python package designed to render animations of matplotlib objects, in a *timeline* style.
 

diplotocus-0.3.3/src/diplotocus/_version.py

@@ -1 +0,0 @@
-__version__ = "0.3.3"