Merge pull request #1419 from pybamm-team/issue-1413-plotting

Issue 1413 plotting

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Features
 
+-   Added `plot_voltage_components` to easily plot the component overpotentials that make up the voltage ([#1419](https://github.com/pybamm-team/PyBaMM/pull/1419))
+-   Made `QuickPlot` more customizable and added an example ([#1419](https://github.com/pybamm-team/PyBaMM/pull/1419))
 -   `Solution` objects can now be created by stepping *different* models ([#1408](https://github.com/pybamm-team/PyBaMM/pull/1408))
 -   Added support for Python 3.9 and dropped support for Python 3.6. Python 3.6 may still work but is now untested ([#1370](https://github.com/pybamm-team/PyBaMM/pull/1370))
 -   Added the electrolyte overpotential and Ohmic losses for full conductivity, including surface form ([#1350](https://github.com/pybamm-team/PyBaMM/pull/1350))

examples/notebooks/compare-particle-diffusion-models.ipynb

@@ -344,7 +344,20 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.4"
+   "version": "3.8.8"
+  },
+  "toc": {
+   "base_numbering": 1,
+   "nav_menu": {},
+   "number_sections": true,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": true
   }
  },
  "nbformat": 4,

pybamm/__init__.py

@@ -239,8 +239,15 @@ def version(formatted=False):
 from .plotting.quick_plot import QuickPlot, close_plots
 from .plotting.plot import plot
 from .plotting.plot2D import plot2D
+from .plotting.plot_voltage_components import plot_voltage_components
 from .plotting.dynamic_plot import dynamic_plot
 
+# Define the plot-style string and set the default plotting style (can be overwritten
+# in a specific script)
+default_plot_style = os.path.join(root_dir(), "pybamm/plotting/pybamm.mplstyle")
+import matplotlib.pyplot as plt
+
+plt.style.use(default_plot_style)
 #
 # Simulation
 #

pybamm/plotting/plot.py

@@ -23,6 +23,8 @@ def plot(x, y, xlabel=None, ylabel=None, title=None, testing=False, **kwargs):
         The label for the y axis
     testing : bool, optional
         Whether to actually make the plot (turned off for unit tests)
+    kwargs
+        Keyword arguments, passed to plt.plot
 
     """
     import matplotlib.pyplot as plt

pybamm/plotting/plot2D.py

@@ -52,7 +52,6 @@ def plot2D(x, y, z, xlabel=None, ylabel=None, title=None, testing=False, **kwarg
         z.entries,
         vmin=ax_min(z.entries),
         vmax=ax_max(z.entries),
-        cmap="coolwarm",
         **kwargs
     )
     plt.xlabel(xlabel)

pybamm/plotting/plot_voltage_components.py

@@ -0,0 +1,80 @@
+#
+# Method for plotting voltage components
+#
+import numpy as np
+
+
+def plot_voltage_components(
+    solution, ax=None, show_legend=True, testing=False, **kwargs_fill
+):
+    """
+    Generate a plot showing the component overpotentials that make up the voltage
+
+    Parameters
+    ----------
+    solution : :class:`pybamm.Solution`
+        Solution object from which to extract voltage components
+    ax : matplotlib Axis, optional
+        The axis on which to put the plot. If None, a new figure and axis is created.
+    show_legend : bool, optional
+        Whether to display the legend. Default is True
+    testing : bool, optional
+        Whether to actually make the plot (turned off for unit tests)
+    kwargs_fill
+        Keyword arguments, passed to ax.fill_between
+
+    """
+    import matplotlib.pyplot as plt
+
+    # Set a default value for alpha, the opacity
+    kwargs_fill = {"alpha": 0.6, **kwargs_fill}
+
+    if ax is not None:
+        testing = True
+    else:
+        _, ax = plt.subplots()
+
+    overpotentials = [
+        "X-averaged battery reaction overpotential [V]",
+        "X-averaged battery concentration overpotential [V]",
+        "X-averaged battery electrolyte ohmic losses [V]",
+        "X-averaged battery solid phase ohmic losses [V]",
+    ]
+
+    # Plot
+    # Initialise
+    time = solution["Time [h]"].entries
+    initial_ocv = solution["X-averaged battery open circuit voltage [V]"](0)
+    ocv = solution["X-averaged battery open circuit voltage [V]"].entries
+    ax.fill_between(time, ocv, initial_ocv, **kwargs_fill)
+    top = ocv
+    # Plot components
+    for overpotential in overpotentials:
+        bottom = top + solution[overpotential].entries
+        ax.fill_between(time, bottom, top, **kwargs_fill)
+        top = bottom
+    V = solution["Battery voltage [V]"].entries
+    ax.plot(time, V, "k--")
+    if show_legend:
+        labels = [
+            "Voltage",
+            "Open-circuit voltage",
+            "Reaction overpotential",
+            "Concentration overpotential",
+            "Ohmic electrolyte overpotential",
+            "Ohmic electrode overpotential",
+        ]
+        leg = ax.legend(labels, loc="lower left", frameon=True)
+        leg.get_frame().set_edgecolor("k")
+
+    # Labels
+    ax.set_xlim([time[0], time[-1]])
+    ax.set_xlabel("Time [h]")
+
+    y_min, y_max = 0.98 * np.nanmin(V), 1.02 * np.nanmax(initial_ocv)
+    ax.set_ylim([y_min, y_max])
+
+    if not testing:  # pragma: no cover
+        plt.show()
+
+    return ax

pybamm/plotting/pybamm.mplstyle

@@ -0,0 +1,22 @@
+# Plot style based on seaborn-paper
+axes.labelsize: 11
+axes.titlesize: 12
+xtick.labelsize: 9
+ytick.labelsize: 9
+legend.fontsize: 9
+
+axes.prop_cycle: cycler('color', ["r", "b", "k", "g", "m", "c"])
+grid.linewidth: 0.8
+lines.linewidth: 1.8
+patch.linewidth: 0.24
+
+xtick.major.width: 0.8
+ytick.major.width: 0.8
+xtick.minor.width: 0.4
+ytick.minor.width: 0.4
+
+xtick.major.pad: 5.6
+ytick.major.pad: 5.6
+
+image.cmap: coolwarm
+pcolor.shading: gouraud