Region

The Region class contains data related to regions, including trade routes. One Region instance is given for each region.

Parameters

id (str): Used to represent the region name.

trade_routes ({region:{commodity:{year:bool}}}) - OSeMOSYS TradeRoute. Boolean tag indicating which other regions may trade the specified commodities with the current region. Optional, defaults to None.

Examples

A simple example of how a region ("R1") might be defined as able to trade the commodity "COAL" with region "R2" is given below, along with how it can be used to create an instance of the Region class:

from tz.osemosys.schemas.region import Region

basic_region = dict(
    id="R1",
    trade_routes={"R2": {"COAL": {"2020": True, "2021": True, "2022": True}}},
)

Region(**basic_region)

This model can be expressed more simply using the wildcard * for dimensions over which data is repeated:

basic_region = dict(
    id="R1",
    trade_routes={"R2": {"COAL": {"*": True}}},
)