Models

class ixmp4.core.model.ModelServiceFacade(backend: Backend)

create(name: str) → Model

Creates a model.

platform.models.create("Model")
#> <Model 1 name='Model'>

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

Deletes a model.

platform.models.delete("Model")

Parameters:

ref (ixmp4.core.model.Model | int | str) – Model object, model id or model name.

Raises:

ModelNotFound – If no model matching ref exists.
ModelDeletionPrevented – If the model matching ref is used in the database, preventing its deletion.
Unauthorized – If the current user is not authorized to perform this action.

get_by_name(name: str) → Model

Retrieves a model by its name.

platform.models.get_by_name("Model")
#> <Model 1 name='Model'>

Lists models by specified criteria.

platform.models.list()
#> [<Model 1 name='Model'>]

Parameters:: **kwargs (any) – Filter parameters as specified in ModelFilter.
Returns:: List of models.
Return type:: list[ixmp4.core.model.Model]

Tabulates models by specified criteria.

platform.models.tabulate()
#>     name  id
# 0  Model   1

Parameters:

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

Returns:

A data frame with the columns:

Return type:

pandas.DataFrame

class ixmp4.core.model.Model(backend: Backend, dto: DtoT)