Merge pull request #1252 from knutfrode/dev

markersize as input to animation method can now be an element propert…

examples/example_chemicaldrift.py

@@ -100,6 +100,7 @@
 
 o.animation(color='specie',
             markersize='mass',
+            markersize_scaling=100,
             vmin=0,vmax=o.nspecies-1,
             colorbar=False,
             fast = True,

examples/example_shyfem.py

@@ -40,5 +40,5 @@
 
 #%%
 # .. image:: /gallery/animations/example_shyfem_0.gif
+# .. image:: /gallery/animations/example_shyfem_1.gif
 o.plot(fast=True, buffer = 1., corners=[12.2, 12.6, 45.1, 45.5])
-

opendrift/models/basemodel/__init__.py

@@ -2529,6 +2529,7 @@ def animation(self,
                   lcs=None,
                   surface_only=False,
                   markersize=20,
+                  markersize_scaling=1,
                   origin_marker=None,
                   legend=None,
                   legend_loc='best',
@@ -2552,16 +2553,6 @@ def animation(self,
                 compare)
             kwargs.update(compare_args)
 
-        markersizebymass = False
-        if isinstance(markersize, str):
-            if markersize.startswith('mass'):
-                markersizebymass = True
-                if markersize[len('mass'):] == '':
-                    # default initial size if not specified
-                    markersize = 100
-                else:
-                    markersize = int(markersize[len('mass'):])
-
         start_time = datetime.now()
         if cmap is None:
             cmap = 'jet'
@@ -2660,22 +2651,9 @@ def plot_timestep(i):
                     np.c_[x_deactive[index_of_last_deactivated < i],
                           y_deactive[index_of_last_deactivated < i]])
 
-                if markersizebymass:
-                    if 'chemicaldrift' in self.__module__:
-                        points.set_sizes(
-                            markersize *
-                            (self.history['mass'][:, i] /
-                             (self.history['mass'][:, i] +
-                              self.history['mass_degraded'][:, i] +
-                              self.history['mass_volatilized'][:, i])))
-                    elif 'openoil' in self.__module__:
-                        points.set_sizes(
-                            markersize *
-                            (self.history['mass_oil'][:, i] /
-                             (self.history['mass_oil'][:, i] +
-                              self.history['mass_biodegraded'][:, i] +
-                              self.history['mass_dispersed'][:, i] +
-                              self.history['mass_evaporated'][:, i])))
+                if isinstance(markersize, str):
+                    points.set_sizes(markersize_scaling *
+                            (self.history[markersize][:, i] / self.history[markersize].compressed()[0]))
 
                 if color is not False:  # Update colors
                     points.set_array(colorarray[:, i])
@@ -2801,7 +2779,7 @@ def plot_timestep(i):
         else:
             c = []
 
-        if markersizebymass:
+        if isinstance(markersize, str):
             points = ax.scatter([], [],
                                 c=c,
                                 zorder=10,
@@ -2843,13 +2821,13 @@ def plot_timestep(i):
             ax.legend(markers, legend, loc=legend_loc)
 
         # Plot deactivated elements, with transparency
-        if markersizebymass:
+        if isinstance(markersize, str):
             points_deactivated = ax.scatter([], [],
                                             c=c,
                                             zorder=9,
                                             vmin=vmin,
                                             vmax=vmax,
-                                            s=markersize,
+                                            s=markersize_scaling,
                                             cmap=cmap,
                                             edgecolor=[],
                                             alpha=0,