*************
Visualization
*************

mGrowthCtrl provides plotting utilities for visualizing experimental data,
model fits (see :doc:`../fitting/lsq`), and MCMC results (see
:doc:`../fitting/mcmc`). To experiment with the visualization settings, we
recommend exploring the jupyter notebooks in the "examples" directory.


Plotting Data with Model Overlay
================================

.. autofunction:: mgrowthctrl.utils.plot.plot_data_with_overlay

Example output for a model fitted with least-squares:

.. image:: ../_static/example_plot.png
   :alt: Example of the results of the plot_data_with_overlay function, fitted
      with least-squares
   :align: center

Example output for an MCMC fit, including error bands:

.. image:: ../_static/crm_mcmc_example.png
   :alt: Example of the results of the plot_data_with_overlay function, fitted
      with MCMC
   :align: center

MCMC Diagnostics
================

.. autofunction:: mgrowthctrl.utils.plot.plot_mcmc_error_evolution

Example output:

.. image:: ../_static/mcmc_error.png
   :alt: MCMC error chain
   :align: center

.. autofunction:: mgrowthctrl.utils.plot.plot_parameter_distributions

Example output:

.. image:: ../_static/param_dist.png
   :alt: MCMC parameter distribution
   :align: center