message_ix_models.tools.iea.eei.Plot

class message_ix_models.tools.iea.eei.Plot

Bases: Plot

Diagnostic plot of processed data.

__init__()

Methods

__init__()
add_tasks(c, key, *inputs[, strict])	Add a task to c to generate and save the Plot.
generate(data)	Generate and return the plot.
make_task(*inputs)	Return a task tuple to add to a Computer.
save(config, *args, **kwargs)	Prepare data, call generate(), and save to file.

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.
static
suffix	File extension; determines file format.

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

Add a task to c to generate and save the Plot.

Analogous to Operator.add_tasks().

basename = 'IEA_EEI-data'

File name base for saving the plot.

generate(data)

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().

inputs: Sequence[Hashable] = []

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

Prepare data, call generate(), and save to file.

This method is used as the callable in the task generated by add_tasks().

Added in version 1.24.1: This method uses disable_copy_on_write() to work around has2k1/mizani#38. This may cause issues if other computations (for instance, of the inputs to the Plot) rely on Pandas’ copy-on-write behaviour being enabled.

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

Keyword arguments for plotnine.ggplot.save.

suffix = '.pdf'

File extension; determines file format.