Global Settings

Input for setting global parameters for the LtmApi.

Required input

The global settings must include the following required input:

Required input

Parameter

Type

Description

name

string

Object name

output_path

string

Output and runtime directory where LTM will read and write

simulation_period

Txy

With timestamps and optional scenarios, see Simulation period

historical_period

Txy

With timestamps and optional scenarios, see Historical period

timesteps_per_week

int

Temporal resolution for each EFI-week (option 1)

intraweek_timesteps

Txy

Takes timestamps and scenarios (option 2), see LTM-core short-term period
Setting the temporal resolution for each EFI-week must be specified by one of the two attributes:

  • timesteps_per_week: int,

  • intraweek_timesteps: takes an Txy with timestamps and scenarios

as explained in LTM-core short-term period.

Minimal example JSON

Minimal example

 
"global_settings": {
    "name": "fbmc",
    "output_path": "testout_fbmc/",
    "simulation_period": {
        "timestamps": [
            "2024-01-01T00:00:00Z",
            "2026-12-28T00:00:00Z"
        ]
    },
    "historical_period": {
        "timestamps": [
            "1981-01-01T00:00:00Z",
            "1989-01-01T00:00:00Z"
        ]
    },
    "timesteps_per_week": 56
}

Optional input

optional settings include

Global Settings optional input

Parameter

Type

Description

water_value_period

Txy

See Water value period

forecast_period

Txy

Timestamps and optional scenarios

data_period

Txy

See Data period

historical_type

string

Calendar system used for historical period, see Historical period

simulation_type

string

“serial” or “parallel”, see Simulation modes

model_type

string

Specifies the simulator type. Options are “EOPS” and “EMPS”

ltm_license_file_path

string

Path to LTM license file (relative or absolute)

interest_rate

double

Weekly discount rate for income/expenses (present value)

generate_output_dir

boolean

If true, creates subdirectories under output_path

#comment

string

User comment

max_iterations

int

Max iterations for area water value calculations

precision

double

Max allowed deviation in water value calculation

default_max_iterations_battery

int

Max iterations for battery areas

default_precision_battery

double

Max allowed deviation for battery areas

delete_output_dir

boolean

Delete runtime directory after execution

ignore_stopwords

boolean

Continue execution despite EMPS/EOPS log errors

allow_validation_failures

boolean

Ignores validation failures

fbmc

boolean

Activate Flow-Based Market-Coupling, see FBMC example

fbmc_period

Txy

The period for which the FBMC functionality is active. The period start must always match the simulation period start

jao_data_source

string

JAO data source (file) with PTDF data. Reads FBMC input files following the JAO data structure on .json format.

export_directory_path

string

Directory to export to, see Exporting of results

export_settings

varies

Specifies which data to export, see Exporting of results

export_target

varies

Specifies exporter target type, see Exporting of results

num_price_scenarios

int

Number of price scenarios

num_processes

int

Number of parallel (MPI) processes

etha

double

Correction factor for local transmission losses

metadata

json

User metadata