Fixed Installation with setup.py. Updated notebook. Made quiver plot arrows to be drawn from the center by default. Added requirements to README file

Author: davidcortesortuno

README.md

@@ -32,6 +32,9 @@ Clone the repository and from it, as a root user, do
 
 This will add `plot_vtk_matplotlib` to the Python libraries.
 
+The library needs `matplotlib`, `scipy` and `vtk` to work. It is recommended
+to install the latest versions using `pip`.
+
 # License
 
 A BSD license statement can be found in the `license.txt` file. 

minimal_example.py

@@ -0,0 +1 @@
+from plot_vtk_matplotlib import *

plot_vtk_matplotlib/__init__.py

@@ -1,6 +1,15 @@
 """
 
-    FUTURE IDEAS::
+plot_vtk_matplotlib library for plotting VTK files in two dimensions
+using Matplotlib
+
+Authors: David Cortes, Hans Fangohr
+
+License: BSD, stated in the Github repository:
+    https://github.com/fangohr/plot_vtk_matplotlib
+
+
+FUTURE IDEAS::
 
     A 3D plot is also possible to do, but the plt.quiver() function
     is still under development, and handling thousands of vectors
@@ -22,8 +31,9 @@
 
 import colorsys
 
-matplotlib.rcParams.update({'font.size': 22})  # This should be equivalent
-#                                               # in structure than before
+# We can change Matplotlib parameters as
+matplotlib.rcParams['font.size'] = 22
+# Or as
 matplotlib.rcParams.update({'xtick.labelsize': 16})
 matplotlib.rcParams.update({'ytick.labelsize': 16})
 
@@ -101,7 +111,10 @@ def extract_data(self):
 
         """
 
-        # Check the type of file to load it according ot it
+        # Check the type of file to load it according to its grid structure
+        # which was specified when calling the class These dictionary entries
+        # return the corresponding VTK Reader functions, so they can be easily
+        # called according to the class argument
         reader_type = {
             'XMLUnstructuredGrid': lambda: vtk.vtkXMLUnstructuredGridReader(),
             'XMLStructuredGrid': lambda: vtk.vtkXMLStructuredGridReader(),
@@ -240,6 +253,7 @@ def plot_vtk(self,
                  colorbar_label='',
                  quiver_type='raw_cmap',
                  quiver_color='k',
+                 pivot='middle',
                  nx_q=20,
                  ny_q=20,
                  frame=True,
@@ -356,6 +370,10 @@ def plot_vtk(self,
         quiver_color        :: Arrow color if one of the 'color' options was
                                specified in the quiver_type argument
 
+        pivot               :: By default we make the arrows to be drawn at the
+                               center of the grid nodes. This option is from
+                               the matplotlib quiver function
+
         nx_q, ny_q          :: Resolution in the x and y directions for the
                                arrows in the quiver plot if one of the
                                interpolated quiver_type options are passed
@@ -644,6 +662,7 @@ def convert_to_rgb(a):
                       # component of m_component
                       quiv[v_component],
                       cmap=quiver_map,
+                      pivot=pivot,
                       **quiver_args
                       )
         elif (quiver_type == 'interpolated_colour'
@@ -653,6 +672,7 @@ def convert_to_rgb(a):
                       quiv['vx'],
                       quiv['vy'],
                       color=quiver_color,
+                      pivot=pivot,
                       **quiver_args
                       )
         elif not quiver_type:
@@ -689,6 +709,7 @@ def plot_quiver(self,
                     interpolator='scipy',
                     quiver_type='raw_cmap',
                     quiver_color='k',
+                    pivot='middle',
                     linewidth=0.7,
                     x_min=-10, y_min=-10,
                     x_max=10, y_max=10,
@@ -757,6 +778,10 @@ def plot_quiver(self,
         quiver_color        :: Arrow color if one of the 'color' options was
                                specified in the quiver_type argument
 
+        pivot               :: By default we make the arrows to be drawn at the
+                               center of the grid nodes. This option is from
+                               the matplotlib quiver function
+
         linewidth           :: Arrows line width
 
         x_min, x_max        :: Range of spatial x values to be used in the
@@ -868,6 +893,7 @@ def plot_quiver(self,
                       linewidth=linewidth,
                       edgecolor='k',
                       facecolor=None,
+                      pivot=pivot,
                       **kwargs
                       )
 
@@ -881,6 +907,7 @@ def plot_quiver(self,
                       alpha=alpha,
                       linewidth=linewidth,
                       color=quiver_color,
+                      pivot=pivot,
                       **kwargs
                       )
 

plot_vtk_matplotlib/plot_vtk_matplotlib.py

@@ -6,5 +6,8 @@
     packages=['plot_vtk_matplotlib'],
     license='BSD',
     description='Library to plot VTK files in 2D with Matplotlib',
-    install_requires=['scipy', 'matplotlib'],
+    # We comment this to avoid upgrading matplotlib when
+    # instaling the library. Could be used in the future.
+    # install_requires=['scipy', 'matplotlib'],
+    author_email='[email protected]'
 )