added double pendulum embedded youtube video to whats_new and documented how to do it in the coding_guide

jdh2358 · jdh2358 · commit d0ba36a0850f · 2011-10-02T11:08:30.000-05:00
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -251,6 +251,37 @@ insert the following special comment anywhere in the script::
 
   # -*- noplot -*-
 
+Animations
+----------
+
+We have a matplotlib google/gmail account with username ``mplgithub``
+which we used to setup the github account but can be used for other
+purposes, like hosting google docs or youtube videos.  You can embed a
+matplotlib animation in the docs by first saving the animation as a
+movie using :meth:`matplotlib.animation.Animation.save`, and then
+uploading to `matplotlib's youtube
+channel <http://www.youtube.com/user/matplotlib>`_ and inserting the
+embedding string youtube provides like::
+
+  .. raw:: html
+
+     <iframe width="420" height="315"
+       src="http://www.youtube.com/embed/32cjc6V0OZY"
+       frameborder="0" allowfullscreen>
+     </iframe>
+
+An example save command to generate a movie looks like this
+
+.. sourcecode:: python
+
+    ani = animation.FuncAnimation(fig, animate, np.arange(1, len(y)),
+        interval=25, blit=True, init_func=init)
+
+    ani.save('double_pendulum.mp4', fps=15)
+
+Contact John Hunter for the login password to upload youtube videos of
+google docs to the mplgithub account.
+
 .. _referring-to-mpl-docs:
 
 Referring to mpl documents
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -35,7 +35,12 @@ animated figures. The :mod:`~matplotlib.animation` module is intended
 to replace the backend-specific examples formerly in the
 :ref:`examples-index` listings.  Examples using the new framework are
 in :ref:`animation-examples-index`; see the entrancing :ref:`double
-pendulum <animation-double_pendulum_animated>` in action.
+pendulum <animation-double_pendulum_animated>` which uses
+:meth:`matplotlib.animation.Animation.save` to create the movie below.
+
+.. raw:: html
+
+    <iframe width="420" height="315" src="http://www.youtube.com/embed/32cjc6V0OZY" frameborder="0" allowfullscreen></iframe>
 
 This should be considered as a beta release of the framework;
 please try it and provide feedback.
diff --git a/examples/animation/double_pendulum_animated.py b/examples/animation/double_pendulum_animated.py
@@ -84,4 +84,5 @@ def animate(i):
 ani = animation.FuncAnimation(fig, animate, np.arange(1, len(y)),
     interval=25, blit=True, init_func=init)
 
+#ani.save('double_pendulum.mp4', fps=15, clear_temp=False)
 plt.show()
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -87,6 +87,8 @@ def save(self, filename, fps=5, codec='mpeg4', clear_temp=True,
         '''
         Saves a movie file by drawing every frame.
 
+        *filename* is the output filename, eg :file:`mymovie.mp4`
+
         *fps* is the frames per second in the movie
 
         *codec* is the codec to be used,if it is supported by the output method.
@@ -430,7 +432,7 @@ def __init__(self, fig, func, frames=None ,init_func=None, fargs=None,
         self._init_func = init_func
 
         # Needs to be initialized so the draw functions work without checking
-        self._save_seq = [] 
+        self._save_seq = []
 
         TimedAnimation.__init__(self, fig, **kwargs)
 
