message_ix_models.model.transport.plot.ComparePDTCap1

class message_ix_models.model.transport.plot.ComparePDTCap1

Bases: Plot

Passenger activity.

Similar to DemandExoCap1, except comparing multiple scenarios.

• One page per \(n\).

• 5 horizontal panels for scenarios.

• One line with points per \(t\) (=transport mode), coloured by mode.

__init__()

Methods

__init__()
add_tasks(c, key, *inputs[, strict])	Add tasks to c to generate and save the Plot.
generate(*paths)	Generate and return the plot.
ggtitle([extra])	Return plotnine.ggtitle including the current date & time.
groupby_plot(data, *args)	Combination of groupby and ggplot().
make_task(*inputs)	Return a task tuple to add to a Computer.
save(config, *args, **kwargs)	Store the last 2 args appended by add_tasks().

Attributes

basename	File name base for saving the plot.
inputs	Keys referring to Quantities or other inputs accepted by generate().
path	Path for file output.
save_args	Keyword arguments for plotnine.ggplot.save.
single	True if the plot is to be used in a Reporter with keys/tasks for reporting a single scenario.
stage	Workflow stage at which the Plot is to be used.
static	list of plotnine objects that are not dynamic.
suffix	File extension; determines file format.
title	Fixed plot title string.
unit	Units expression for plot title.

classmethod add_tasks(c: Computer, key: KeyLike, *inputs, strict: bool = False) → KeyLike

Add tasks to c to generate and save the Plot.

Beyond the base class method, this method:

• Constructs an output path from basename, suffix, and the make_output_path() operator. This in turn uses the c.config values “output_dir” (if stage is .STAGE.REPORT) or “build debug dir”.

• If single is False, adds a key “scenario” with a dummy URL that can be used by ggtitle().

• Appends 2 keys for the above to the inputs for use by save().

basename = 'compare-pdt-capita-gdp'

File name base for saving the plot.

generate(*paths: Path)

Generate and return the plot.

A subclass of Plot must implement this method.

Parameters:

args (Sequence of pandas.DataFrame or other) –

One argument is given corresponding to each of the inputs.

Because plotnine operates on pandas data structures, save() automatically converts any Quantity inputs to pandas.DataFrame before they are passed to generate().

ggtitle(extra: str | None = None) → PlotAddable

Return plotnine.ggtitle including the current date & time.

groupby_plot(data: DataFrame, *args)

Combination of groupby and ggplot().

Groups by args and yields a series of plotnine.ggplot objects, one per group, with static geoms and ggtitle() appended to each.

inputs: Sequence['KeyLike'] = []

Keys referring to Quantities or other inputs accepted by generate().

classmethod make_task(*inputs)

Return a task tuple to add to a Computer.

Deprecated since version 1.18.0: Use add_tasks() instead.

Parameters:

*inputs (.Key or str or hashable, optional) – If provided, overrides the inputs property of the class.

Returns:

• The first, callable element of the task is save().

• The second element is "config", to access the configuration of the Computer.

• The third and following elements are the inputs.

Return type:

tuple

path: Path | None = None

Path for file output. If it is not set, save() will populate it with a value constructed from config["output_dir"], basename, and suffix. The implementation of generate() in a Plot sub-class may assign any other value, for instance one constructed at runtime from the inputs.

save(config, *args, **kwargs) → Path | None

Store the last 2 args appended by add_tasks().

save_args: dict[str, Any] = {'verbose': False}

Keyword arguments for plotnine.ggplot.save.

single: bool = False

True if the plot is to be used in a Reporter with keys/tasks for reporting a single scenario. Use False for plots of data from multiple scenarios.

stage: Literal[STAGE.BUILD, STAGE.REPORT] = 1

Workflow stage at which the Plot is to be used.

static: list['PlotAddable'] = [<plotnine.themes.theme.theme object>, {'color': 't', 'x': 'gdp', 'y': 'value'}, <plotnine.geoms.geom_line.geom_line object>, <plotnine.geoms.geom_point.geom_point object>, scale_x_log10(name=None, breaks=True, limits=None, labels=True, expand=None, guide=None, na_value=nan, aesthetics=['x', 'xmin', 'xmax', 'xend', 'xintercept'], rescaler=<function rescale>, oob=<function censor>, minor_breaks=True, trans='log10'), scale_y_log10(name=None, breaks=True, limits=None, labels=True, expand=None, guide=None, na_value=nan, aesthetics=['y', 'ymin', 'ymax', 'yend', 'yintercept', 'ymin_final', 'ymax_final', 'lower', 'middle', 'upper'], rescaler=<function rescale>, oob=<function censor>, minor_breaks=True, trans='log10'), labs(x='GDP [10³ USD_2017 / capita]', y='', alpha=None, color='Transport mode', colour=None, fill=None, linetype=None, shape=None, size=None, stroke=None, title=None, subtitle=None, caption=None, tag=None), <plotnine.facets.facet_wrap.facet_wrap object>]

list of plotnine objects that are not dynamic.

Type:

‘Static’ geoms

suffix = '.pdf'

File extension; determines file format.

title: str | None = None

Fixed plot title string. If not given, the first line of the class docstring is used.

unit: str | None = 'km/a'

Units expression for plot title.