.. _plothist:

plothist
========

.. toctree::
   :maxdepth: 1
   :caption: Plothist:

    plothist instant       <plothist/plothist_instant>
    plothist average       <plothist/plothist_average>
    plothist evolution     <plothist/plothist_evolution>


usage::

 plothist [-h] [-r RCFILE] [--quiet | --verbose | --debug] [--version]
                {help,instant,average,evolution} ...

Plot probability density functions (histograms) generated by w_pdist or other
programs conforming to the same output format. This program operates in one of
three modes::

  instant
    Plot 1-D and 2-D histograms for an individual iteration. See
    ``plothist instant --help`` for more information.

  average
    Plot 1-D and 2-D histograms, averaged over several iterations. See
    ``plothist average --help`` for more information.

  evolution
    Plot the time evolution 1-D histograms as waterfall (heat map) plots.
    See ``plothist evolution --help`` for more information.

This program takes the output of ``w_pdist`` as input (see ``w_pdist --help``
for more information), and can generate any kind of graphical output that
matplotlib supports.

------------------------------------------------------------------------------
Command-line options
------------------------------------------------------------------------------

optional arguments::

  -h, --help            show this help message and exit

general options::

  -r RCFILE, --rcfile RCFILE
                        use RCFILE as the WEST run-time configuration file (default: west.cfg)
  --quiet               emit only essential information
  --verbose             emit extra information
  --debug               enable extra checks and emit copious information
  --version             show program's version number and exit

plotting modes::

  {help,instant,average,evolution}
    help                print help for this command or individual subcommands
    instant             plot probability distribution for a single WE iteration
    average             plot average of a probability distribution over a WE simulation
    evolution           plot evolution of a probability distribution over the course of a WE simulation