Use latest utopya; upgrade .plot.ca `limits` syntax to vmin/vmax

endif()

# -- utopya

set(UTOPYA_REQUIRED_VERSION 1.1.1)

set(UTOPYA_REQUIRED_VERSION 1.1.3)

if(NOT UTOPYA_FROM_PYPI)

    set(UTOPYA_FROM_PYPI On)

.flush_cmap:

  cmap: ~

# -----------------------------------------------------------------------------

# Failing plots for usage/eval/dag/debug.rst

# -----------------------------------------------------------------------------

# Demonstrates a basic line plot

density_basic:

      transform:

        - .sel: [!dag_prev , { kind: [infected] }]

# Demonstrates a basic line plot with style adjustments

### Start --- line_plot

line_plot:

      title: Density of infected agents

### End --- line_plot

# Demonstrates a stacked line plot

stacked_kinds:

  based_on:

    set_title:

      title: Density of agent kinds

# Demonstrates an animated cellular automaton

### Start --- .plot.ca.

animated_ca:

  to_plot:

    kind:

      limits: [0, 3]

      # Use a custom cmap; these colors must be globally defined somewhere

      # Will automatically be mapped to values [0, 1, 2, 3]

      cmap:

        empty: *white

        susceptible: *lightgreen

    font.size: 10

### End --- .plot.ca.

# Demonstrates a simple 2D scatter plot

scatter_2d_simple:

  based_on:

    set_title:

      title: ~

# Demonstrates a 2D scatterplot with an additional variable plotted on the 'hue'

# Demonstrates a 2D scatterplot with an additional variable plotted on 'hue'

### Start --- scatter_2d

scatter_2d:

  based_on:

  color: ~

# Demonstrates a 3D scatter plot with hue

### Start --- scatter_3d

scatter_3d:

      0.8: *lightblue

      1: *darkblue

# Demonstrates some PlotHelper features

helper_demo:

  based_on:

        major:

          locs: [0, 0.1, 0.2, 0.3, 0.4]

          labels: ['No', more, trouble, with, tick labels]

ca/state:

  based_on:

    - .creator.universe

    - .plot.ca

  enabled: false

  select:

    kind: kind

  to_plot:

    kind:

      title: State

      limits: [0, 7]

  suptitle_fstr: False

.. code-block:: yaml

    animated_ca:

      # Base your plot on .plot.ca

      based_on:

        - .creator.universe

      # .plot.ca requires a 'to_plot' key

      to_plot:

        kind:

          limits: [~, 3]

          # title: My title

          vmin: 0

          vmax: 3

          cmap:

            empty: white

            susceptible: lightgreen

:code:`.plot.ca` requires a :code:`to_plot` key, specifying what to put into each subplot.

The keys (here: ``kind``) need to correspond to the selected data entries.

In addition, it is used to specify the limits of the colormap (and other information like a subplot title).

Here, we are only plotting the susceptible, infected, and recovered agents, so we set the limits to :code:`[0, 3]`, and define the colors we want for each :code:`kind`:

In addition, it is used to specify the limits of the colormap (``vmin`` and ``vmax``) and other information like the subplot's title.

Here, we are only plotting empty cells and cells with susceptible, infected, and recovered agents, denoted by the integer ``kind`` values of ``0`` to ``3``.

To ensure that the colormap stays in that range, we set ``vmin`` and ``vmax`` accordingly and define the colors we want for each ``kind``; they are associated depending on the order within ``cmap``, starting at ``vmin`` and going up to ``vmax`` in integer steps:

.. raw:: html

      frames_isel: !range [30, 60]

This will only plot the frames from 30 to 60. You can also manually specify an array, i.e. :code:`frames_isel: [10, 20, 30, 40]`.

This will only plot the frames from 30 to 59.

You can also manually specify a list, i.e. :code:`frames_isel: [10, 20, 30, 40]`.

.. hint::

You can also use the ``.plot.facet_grid`` base configuration with ``kind: pcolormesh`` to animate heatmaps.

    As an alternative for plotting heatmaps that is not specialized on CA, you can use the ``.plot.facet_grid.pcolormesh`` base configuration.

    See the :ref:`article on heatmaps <pcolormesh>` for more details.

.variables:

  base_path: &base_path data/ContDisease

  colors:                                   # state value

  colors: &cmap                             # state value

    # NOTE Order is very important here!

    empty: &color_empty darkkhaki           # 0

    tree: &color_tree forestgreen           # 1

    infected: &color_infected firebrick     # 2

  to_plot:

    kind:

      title: Forest State

      limits: [0, 4]

      cmap:

        empty: *color_empty

        tree: *color_tree

        infected: *color_infected

        source: *color_source

        stone: *color_stone

      cmap: *cmap

# ... The forest age ..........................................................

ca/forest_age:

    age:

      title: Forest Age

      cmap: YlGn

      limits: [0, max]

      vmin: 0

      vmax: max

# ... The clusters ............................................................

ca/clusters:

  to_plot:

    cluster_id:

      title: Clusters

      limits: [0, 20]

      cmap: tab20

      vmin: 0

      vmax: 20

      no_cbar_markings: true

    some_state:

      title: Some State

      cmap: Greens

      limits: [min, max]

      vmin: min

      vmax: max

ca/trait:

  based_on:

    some_trait:

      title: Some Trait

      cmap: Blues

      # limits: [0, ~]

      # vmin: 0

      # vmax: ~