class_docstr: The foundation of all animations.
  
  Parameters
  ----------
  blocks : list of animatplot.animations.Block
      A list of blocks to be animated
  timeline : Timeline or 1D array, optional
      If an array is passed in, it will be converted to a Timeline.
      If not given, a timeline will be created using the length of the
      first block.
  fig : matplotlib figure, optional
      The figure that the animation is to occur on
  
  Attributes
  ----------
  animation
      a matplotlib animation returned from FuncAnimation
class_docstr_tok: ["The","foundation","of","all","animations",".","Parameters","--","--","--","--","--","blocks",":","list","of","animatplot.animations.Block","A","list","of","blocks","to","be","animated","timeline",":","Timeline","or","1D","array",",","optional","If","an","array","is","passed","in",",","it","will","be","converted","to","a","Timeline",".","If","not","given",",","a","timeline","will","be","created","using","the","length","of","the","first","block",".","fig",":","matplotlib","figure",",","optional","The","figure","that","the","animation","is","to","occur","on","Attributes","--","--","--","--","--","animation","a","matplotlib","animation","returned","from","FuncAnimation"]
docstr: Saves the animation to a gif
  
  A convience function. Provided to let the user avoid dealing
  with writers.
  
  Parameters
  ----------
  filename : str
      the name of the file to be created without the file extension
docstr_tok: ["Saves","the","animation","to","a","gif","A","convience","function",".","Provided","to","let","the","user","avoid","dealing","with","writers",".","Parameters","--","--","--","--","--","filename",":","str","the","name","of","the","file","to","be","created","without","the","file","extension"]
code: def save_gif(self, filename):
      """Saves the animation to a gif
  
      A convience function. Provided to let the user avoid dealing
      with writers.
  
      Parameters
      ----------
      filename : str
          the name of the file to be created without the file extension
      """
      self.timeline.index -= (
          1  # required for proper starting point for save
      )
      self.animation.save(
          filename + ".gif", writer=PillowWriter(fps=self.timeline.fps)
      )
  
file_path: animatplot/animatplot/animation.py
imports: from matplotlib.animation import FuncAnimation, PillowWriter
  from matplotlib.widgets import Button, Slider
  import matplotlib.pyplot
  import numpy
  from animatplot import Timeline
label_desc: Use image node_id 5 for calling the Animation obj's underlying member method code with example usage: obj.save_gif(filename) without return types