IAMC Data

class ixmp4.core.iamc.data.PlatformIamcData(_backend: Backend | None = None)

Bases: BaseFacade

tabulate(*, join_runs: bool = True, raw: bool = False, **kwargs: Unpack[EnumerateKwargs]) → DataFrame

variables: VariableRepository

class ixmp4.core.iamc.data.RunIamcData(run: Run, **kwargs: Backend | None)

Bases: BaseFacade

IAMC data.

Parameters

backendixmp4.data.backend.Backend

Data source backend.

runixmp4.base.run.Run

Model run.

add(df: DataFrame, type: Type | None = None) → None

remove(df: DataFrame, type: Type | None = None) → None

run: Run

tabulate(*, variable: dict[str, str | Iterable[str]] | None = None, region: dict[str, str | Iterable[str]] | None = None, unit: dict[str, str | Iterable[str]] | None = None, raw: bool = False) → DataFrame

class ixmp4.core.iamc.variable.Variable(_model: BaseModel | None = None, **kwargs: Backend | None)

Bases: BaseModelFacade

NotFound

alias of VariableNotFound

NotUnique

alias of VariableNotUnique

property created_at: datetime | None

property created_by: str | None

property docs: str | None

property id: int

property name: str

class ixmp4.core.iamc.variable.VariableRepository(_backend: Backend | None = None)

Bases: BaseFacade

create(name: str) → Variable

delete_docs(name: str) → None

get(name: str) → Variable

get_docs(name: str) → str | None

list(name: str | None = None) → list[Variable]

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

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