Energy Reference

This page documents the ENERGY_NETWORK YAML configuration key for the eCalc Asset model.

ENERGY_NETWORK

Defines the energy network configuration.

SOURCES

External energy entering the system (fuel gas, electrical, diesel).

Key	Description	Status
NAME	Unique name for this energy source.	Required
TYPE	Type of external energy source.	Required
CAPACITY	Maximum output capacity. Omit for unlimited.	Optional

UNITS

Converters, junctions, and consumers forming the energy network.

UNITS

GENERATOR_SET

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
CAPACITY	Maximum output capacity. Omit for unlimited.	Optional
TYPE	GENERATOR_SET	Required
MODEL	Reference to a facility model defining the power-to-fuel curve.	Optional

GAS_TURBINE

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
CAPACITY	Maximum output capacity. Omit for unlimited.	Optional
TYPE	GAS_TURBINE	Required
MODEL	Reference to a facility model defining the power-to-fuel curve.	Optional

ELECTRICAL_MOTOR

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
CAPACITY	Maximum output capacity. Omit for unlimited.	Optional
TYPE	ELECTRICAL_MOTOR	Required
EFFICIENCY	Conversion efficiency (0–1]. Defaults to 0.95 if omitted.	Optional

ELECTRICAL_CABLE

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
CAPACITY	Maximum output capacity. Omit for unlimited.	Optional
TYPE	ELECTRICAL_CABLE	Required
EFFICIENCY	Transmission efficiency (0–1]. 1.0 means no loss. Defaults to 1.0 if omitted.	Optional

ELECTRICAL_BUS

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	At least two sources or units feeding into this junction, in dispatch priority order. An entry is either a name, or a NAME with an optional CAPACITY dispatch limit. A single supplier connects directly to its consumers instead.	Required
DISPATCH_STRATEGY	How to allocate demand across the inputs.	Required
TYPE	ELECTRICAL_BUS	Required

INPUT

At least two sources or units feeding into this junction, in dispatch priority order. An entry is either a name, or a NAME with an optional CAPACITY dispatch limit. A single supplier connects directly to its consumers instead.

Key	Description	Status
NAME	Source or unit feeding into this junction.	Required
CAPACITY	Dispatch limit for this input, measured at the junction after any upstream loss. It guides how demand is split and does not cap it: demand beyond every limit is placed on the last input, and exceeding a limit is not itself a capacity failure. Omit for unlimited, until a deliverability rule exists.	Optional

FUEL_GAS_MANIFOLD

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	At least two sources or units feeding into this junction, in dispatch priority order. An entry is either a name, or a NAME with an optional CAPACITY dispatch limit. A single supplier connects directly to its consumers instead.	Required
DISPATCH_STRATEGY	How to allocate demand across the inputs.	Required
TYPE	FUEL_GAS_MANIFOLD	Required

INPUT

At least two sources or units feeding into this junction, in dispatch priority order. An entry is either a name, or a NAME with an optional CAPACITY dispatch limit. A single supplier connects directly to its consumers instead.

Key	Description	Status
NAME	Source or unit feeding into this junction.	Required
CAPACITY	Dispatch limit for this input, measured at the junction after any upstream loss. It guides how demand is split and does not cap it: demand beyond every limit is placed on the last input, and exceeding a limit is not itself a capacity failure. Omit for unlimited, until a deliverability rule exists.	Optional

ELECTRICAL_CONSUMER

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
TYPE	ELECTRICAL_CONSUMER	Required
LOAD	Electrical power demand (MW).	Required

MECHANICAL_CONSUMER

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
TYPE	MECHANICAL_CONSUMER	Required
LOAD	Shaft power demand (MW). Mutually exclusive with PROCESS_SIMULATION.	Optional
PROCESS_SIMULATION	Reference to a process simulation that determines shaft power demand. Mutually exclusive with LOAD.	Optional

FUEL_GAS_CONSUMER

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
TYPE	FUEL_GAS_CONSUMER	Required
RATE	Fuel gas consumption rate (Sm³/d).	Required

DIESEL_CONSUMER

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
TYPE	DIESEL_CONSUMER	Required
RATE	Diesel consumption rate (l/d).	Required

COMPRESSOR_SAMPLED

A compressor whose energy usage is tabulated in FILE against RATE, SUCTION_PRESSURE and/or DISCHARGE_PRESSURE. Which energy columns FILE has decides what the unit consumes:

• Only FUEL: a fuel gas consumer. INPUT must provide fuel gas.
• Only POWER: a power consumer, electrical or mechanical after what INPUT provides.
• Both FUEL and POWER: a gas turbine named <NAME> turbine is generated and wired between INPUT (which must provide fuel gas) and the compressor. The compressor demands the tabulated POWER as shaft power and the turbine converts it back to the tabulated FUEL.

Every variable tabulated in FILE must be given as an expression, and every given expression must be tabulated.

NAME: gas_compressor_sampled
INPUT: fuel_manifold
TYPE: COMPRESSOR_SAMPLED
FILE: gas_compressor_sampled.csv
RATE: 2500000
SUCTION_PRESSURE: 40
DISCHARGE_PRESSURE: 120

Key	Description	Status
NAME	Unique name for this component.	Required
INPUT	Source or component this receives energy from.	Required
TYPE	COMPRESSOR_SAMPLED	Required
FILE	Resource tabulating FUEL and/or POWER against RATE, SUCTION_PRESSURE and/or DISCHARGE_PRESSURE.	Required
RATE	Rate through the compressor (Sm³/d), looked up in FILE.	Optional
SUCTION_PRESSURE	Compressor inlet pressure (bara), looked up in FILE.	Optional
DISCHARGE_PRESSURE	Compressor outlet pressure (bara), looked up in FILE.	Optional