Visualization with plopm
========================

Overview
--------

`plopm <https://github.com/cssr-tools/plopm>`_ can postprocess the OPM Flow
results generated by pofff and create customized PNG figures and GIF animations.

Installation
------------

.. code-block:: console

   pip install git+https://github.com/cssr-tools/plopm.git

Configuration
-------------

Run ``publication/appendixb.toml`` after replacing its ``inj`` schedule with:

.. code-block:: toml

   inj = [
       [8100, 300, 3E-7, 0],
       [10200, 300, 3E-7, 3E-7],
       [3300, 300, 0, 0],
       [64800, 3600, 0, 0],
       [345600, 21600, 0, 0],
   ]

Commands
--------

Generate the OPM Flow result without the pofff benchmark figures:

.. code-block:: console

   pofff -i appendixb.toml -o pofff+plopm -m single -c 5e-2 -f none

Generate the dissolved-CO2 animation:

.. code-block:: console

   plopm -v xco2l -i 'pofff+plopm/POFFF+PLOPM' -fs 16,5 -mv satnum -m gif -dpi 1000 -fz 20 -gl 1 -cbf .1e -cbp 0.30,0.01,0.4,0.02 -gi 437.5 -mt 1e-5 -tu h -cbn 5 -cbl 'CO$_2$ mass fraction in liquid [-]' -t 'FluidFlower simulation (GitHub/cssr-tools/pofff),'

Result
------

.. figure:: ../figs/pofff+plopm_xco2l.gif
   :alt: Dissolved CO2 animation generated from a pofff simulation with plopm

   The documented five-day simulation completed in less than two minutes using
   eight OPM Flow CPUs on a Mac.

See the `plopm documentation <https://cssr-tools.github.io/plopm/>`_ for the
complete plotting and animation reference.

Reproduce the example
---------------------

Run the maintained documentation script from the repository root:

.. code-block:: console

   . ./tests/scripts/docs_visualization.sh

.. grid:: 1 1 2 2
   :gutter: 2

   .. grid-item::

      .. button-link:: https://github.com/cssr-tools/pofff/blob/main/tests/scripts/docs_visualization.sh
         :color: primary
         :outline:
         :expand:

         View script

   .. grid-item::

      .. button-link:: https://raw.githubusercontent.com/cssr-tools/pofff/main/tests/scripts/docs_visualization.sh
         :color: primary
         :outline:
         :expand:

         View raw script

.. button-ref:: ../examples
   :color: primary

   Back to examples gallery