Index

Classes

Name Description

Any

n/a

Balance

Nodes that maintain a balance between inputs and outputs in each time step, but do not have a storage.

Commodity

Nodes where the model can buy and sell commodities against an exogenous price.

Constraint

Constraints define constraints on multiple variables at once

ConstraintFloat

n/a

ConversionRatesFloatFloat

n/a

Dataset

Dataset properties and holder for classes available in the schema.

DirectionalValue

To which direction the parameter value is applied for in a link.

Entity

Abstract top-level class that contains all other classes (except Dataset).

Group

Groups define constraints on multiple entities at once

Group_entity

Makes an entity to be a member of a group

HasFlow

Mixin for flow (annual_flow, flow_profile) related properties.

HasInvestments

Mixin for investment related attributes.

HasPenalty

Mixin for penalty related attributes (penalty_upward, penalty_downward).

HasProfiles

Mixin for profile related attributes.

Link

Connects two nodes.

Node

Abstract class that contains all types of nodes

Node_to_unit

An input port from a node to a unit.

Period

The properties of the periods available for the model.

PeriodFloat

n/a

Port

Ports designates an input or an output between a unit and a node.

Solve_pattern

Defines the properties of each solve pattern.

Storage

Nodes that include a state variable to represent storage. Also maintains balance between inputs and outputs including charging and discharging of the state.

System

Parameters related to the whole system to be modelled.

Timeset

n/a

Unit

Units convert input(s) to output(s) using a ratio multiplier.

Unit_to_node

An output port from a unit to a node.

Types

No types are defined in the schema.

Enumerations

Name Description

CommodityType

Limits allowed commodity types

ConversionMethod

Choose how the unit converts inputs to outputs

Equality

n/a

FlowScalingMethod

How to use flow_profile and flow_annual.

GroupType

Limits allowed group types

InvestmentMethod

Choice of investment method.

NodeType

Limits allowed node types: Balance, Storage, Commodity

SolveMode

Choice of solve process handled within the model.

StartupMethod

Choose how the unit startup methods are treated

TransferMethod

How to transfer between the two links.