Regions

class ixmp4.core.region.Region(_model: BaseModel | None = None, **kwargs: Backend | None)

Bases: BaseModelFacade

DeletionPrevented

alias of RegionDeletionPrevented

NotFound

alias of RegionNotFound

NotUnique

alias of RegionNotUnique

property created_at: datetime | None

property created_by: str | None

delete() → None

Deletes the region from the database.

property docs: str | None

property hierarchy: str

Region hierarchy.

property id: int

Unique id.

property name: str

Region name.

class ixmp4.core.region.RegionRepository(_backend: Backend | None = None)

Bases: BaseFacade

create(name: str, hierarchy: str) → Region

delete(x: Region | int | str) → None

delete_docs(name: str) → None

get(name: str) → Region

get_docs(name: str) → str | None

list(name: str | None = None, hierarchy: str | None = None) → list[Region]

set_docs(name: str, description: str | None) → str | None

tabulate(name: str | None = None, hierarchy: str | None = None) → DataFrame