.. Hydroflow documentation file, created by
   Pierre-Yves Gousenbourger on Wed Aug 2, 2023.
   modified by Nathan Delpierre on Wen Jan 17 2024

.. _plotter-module:

The Plotter class
=================

What it does
------------

The Plotter class intends to provide easy and hands-on methods to plot results from simulation produced by Watlab. 
For example we provide a simple way to plot a result extracted from a so-called watlab pic file or to create a video from a folder containing results files. 
These methods should be modified by the users in order to meet their expectations. 

Documentation
-------------

.. autoclass:: watlab.watlab.Plotter
     :members:
     :undoc-members: