Scenarios

class ixmp4.core.scenario.ScenarioServiceFacade(backend: Backend)

create(name: str) → Scenario

Creates a scenario.

platform.scenarios.create("Scenario")
#> <Scenario 1 name='Scenario'>

delete(ref: Scenario | int | str) → None

Deletes a scenario.

platform.scenarios.delete("Scenario")

Parameters:

ref (ixmp4.core.scenario.Scenario | int | str) – Unit object, unit id or unit name.

Raises:

ScenarioNotFound – If no scenario matching ref exists.
ScenarioDeletionPrevented – If the scenario matching ref is used in the database, preventing it deletion.
Unauthorized – If the current user is not authorized to perform this action.

get_by_name(name: str) → Scenario

Retrieves a scenario by its name.

platform.scenarios.get_by_name("Scenario")
#> <Scenario 1 name='Scenario'>

Lists scenarios by specified criteria.

platform.scenarios.list()
#> [<Scenario 1 name='Scenario'>]

Parameters:: **kwargs (any) – Filter parameters as specified in ScenarioFilter.
Returns:: List of scenarios.
Return type:: list[ixmp4.core.scenario.Scenario]

Tabulates scenarios by specified criteria.

platform.scenarios.tabulate()
#>     name  id
# 0  Scenario   1

Parameters:

**kwargs (any) – Filter parameters as specified in ScenarioFilter.

Returns:

A data frame with the columns:

Return type:

pandas.DataFrame

class ixmp4.core.scenario.Scenario(backend: Backend, dto: DtoT)