bluebonnet.plotting
===================

.. py:module:: bluebonnet.plotting

.. autoapi-nested-parse::

   Ease plotting production and fluid flow information.



Attributes
----------

.. autoapisummary::

   bluebonnet.plotting.Reservoir


Classes
-------

.. autoapisummary::

   bluebonnet.plotting.SquareRootScale


Functions
---------

.. autoapisummary::

   bluebonnet.plotting.plot_pseudopressure
   bluebonnet.plotting.plot_recovery_rate
   bluebonnet.plotting.plot_recovery_factor


Module Contents
---------------

.. py:data:: Reservoir

.. py:class:: SquareRootScale(axis, **kwargs)

   Bases: :py:obj:`matplotlib.scale.ScaleBase`


   ScaleBase class for generating square root scale.


   .. py:attribute:: name
      :value: 'squareroot'



   .. py:method:: set_default_locators_and_formatters(axis)

      Set major and minor locators and formatters.



   .. py:method:: limit_range_for_scale(vmin, vmax, minpos)

      Do not allow negative values.



   .. py:class:: SquareRootTransform(shorthand_name=None)

      Bases: :py:obj:`matplotlib.transforms.Transform`


      Transform from linear to square root position.


      .. py:attribute:: input_dims
         :value: 1


         The number of input dimensions of this transform.
         Must be overridden (with integers) in the subclass.


      .. py:attribute:: output_dims
         :value: 1


         The number of output dimensions of this transform.
         Must be overridden (with integers) in the subclass.


      .. py:attribute:: is_separable
         :value: True


         True if this transform is separable in the x- and y- dimensions.


      .. py:method:: transform_non_affine(a)

         Actual transform.



      .. py:method:: inverted()

         Inverse transform.




   .. py:class:: InvertedSquareRootTransform(shorthand_name=None)

      Bases: :py:obj:`matplotlib.transforms.Transform`


      Inverted square-root transform.


      .. py:attribute:: input_dims
         :value: 1


         The number of input dimensions of this transform.
         Must be overridden (with integers) in the subclass.


      .. py:attribute:: output_dims
         :value: 1


         The number of output dimensions of this transform.
         Must be overridden (with integers) in the subclass.


      .. py:attribute:: is_separable
         :value: True


         True if this transform is separable in the x- and y- dimensions.


      .. py:method:: transform(a)

         Square everything.



      .. py:method:: inverted()

         Square root it. (Inverse of inverse).




   .. py:method:: get_transform()

      Get square root transform.



.. py:function:: plot_pseudopressure(reservoir: Reservoir, every: int = 200, rescale: bool = False, ax: matplotlib.pyplot.Axes = None, x_max: float = 1, y_max: float | None = None, plot_kwargs: dict[str, Any] | None = None) -> matplotlib.pyplot.Axes

   Plot pseudopressure versus distance over time.

   :param reservoir: simulated reservoir
   :type reservoir: Reservoir
   :param every: timesteps between a plotted pseudopressure profile, by default 200
   :type every: int, optional
   :param rescale: if true, rescale pseudopressure by initial value, by default False
   :type rescale: bool, optional
   :param ax: axes to plot on, by default None
   :type ax: plt.Axes, optional
   :param x_max: maximum distance to plot, by default 1
   :type x_max: float, optional
   :param y_max: maximum pseudopressure to plot, by default None
   :type y_max: float | None, optional
   :param plot_kwargs: arguments to pass to the plotting routine
   :type plot_kwargs: dict[str,Any] | None, optional

   :returns: pseudopressure plotted
   :rtype: plt.Axes


.. py:function:: plot_recovery_rate(reservoir: Reservoir, ax: matplotlib.pyplot.Axes | None = None, change_ticks: bool = False, plot_kwargs: dict[str, Any] | None = None) -> matplotlib.pyplot.Axes

   Plot recovery rate over time.

   :param reservoir: simulated reservoir
   :type reservoir: Reservoir
   :param ax: axes to plot on, by default None
   :type ax: plt.Axes | None, optional
   :param change_ticks: if true, set xticks, by default False
   :type change_ticks: bool, optional
   :param plot_kwargs: arguments to pass to the plotting routine
   :type plot_kwargs: dict[str,Any] | None, optional

   :returns: recovery rate, plotted
   :rtype: plt.Axes


.. py:function:: plot_recovery_factor(reservoir: Reservoir, ax: matplotlib.pyplot.Axes | None = None, change_ticks: bool = False, plot_kwargs: dict[str, Any] | None = None) -> matplotlib.pyplot.Axes

   Plot cumulatie recovery over time.

   :param reservoir: simulated reservoir
   :type reservoir: Reservoir
   :param ax: axes to plot on, by default None
   :type ax: plt.Axes | None, optional
   :param change_ticks: if true, set xticks, by default False
   :type change_ticks: bool, optional
   :param plot_kwargs: arguments to pass to the plotting routine
   :type plot_kwargs: dict[str,Any] | None, optional

   :returns: recovery rate, plotted
   :rtype: plt.Axes