Configuration reference

Parameter Catalog

Engineering parameters describe cells, sites, antennas, carriers, beamforming, and energy-saving controls. UE parameters describe device-side configuration that can be overridden before a run.

How Parameter Updates Work

set_engineering_parameter and set_ue_parameter are atomic: each call updates one parameter. Call them after create_simulation and before run_simulation. Use mode: "set" for an absolute value and mode: "delta" for numeric increments.

Cell roles, pairings, and carrier-shutdown settings are listed in Carrier Management Parameters. Read them with get_carrier_management_config and update them with set_carrier_management_config.

{
  "sim_id": "ITU_R_M2135_UMa_uniform_abc123",
  "parameter": "BS_tx_power_max_dBm",
  "value": 40,
  "cells": ["cell_0", "cell_1"],
  "mode": "set"
}

Engineering Parameters

Parameter	Unit	Writable	Description
`radio_unit_type`		Yes	Type of radio unit (macro, micro, pico...)
`radio_unit_initial_status`		Yes	Initial radio unit state: active or carrier_shutdown
`radio_unit_ID`		Yes	Radio unit assigned to the cell (must belong to the same site)
`bbu_ID`		Yes	Baseband unit identifier
`bbu_type`		Yes	Baseband unit type
`RAT`		No	Radio access technology
`TX_number`		No	Number of transmit chains
`RX_number`		No	Number of receive chains
`PCI`		No	Physical Cell Identifier
`indoor`	bool	No	1 if the cell is indoor, 0 otherwise
`BS_tx_power_max_dBm`	dBm	Yes	Base station transmit power. Set to -999 to simulate cell off
`dl_carrier_frequency_GHz`	GHz	No	Downlink carrier frequency
`dl_bandwidth_MHz`	MHz	Yes	Downlink carrier bandwidth
`dl_PRBs_available`	count	No	Number of available downlink PRBs
`dl_subcarrier_spacing_kHz`	kHz	No	Downlink subcarrier spacing
`dl_freq_band`		No	Downlink frequency band
`dl_earfcn`		No	Downlink EARFCN
`dl_carrier_wavelength_m`		No	Downlink carrier wavelength
`dl_ofdm_symbol_duration_us`		No	Downlink OFDM symbol duration
`dl_control_channel_overhead`		No	Downlink control channel overhead
`dl_carrier_index`		No	Downlink carrier index
`ul_carrier_frequency_GHz`	GHz	No	Uplink carrier frequency
`ul_bandwidth_MHz`	MHz	No	Uplink carrier bandwidth
`ul_available_PRBs`	count	No	Number of available uplink PRBs
`ul_subcarrier_spacing_kHz`	kHz	No	Uplink subcarrier spacing
`ul_freq_band`		No	Uplink frequency band
`ul_earfcn`		No	Uplink EARFCN
`ul_carrier_wavelength_m`		No	Uplink carrier wavelength
`ul_ofdm_symbol_duration_us`		No	Uplink OFDM symbol duration
`ul_control_channel_overhead`		No	Uplink control channel overhead
`fdd_tdd_ind`		No	Duplexing mode
`FR`		No	Frequency range
`subcarriers_per_PRB`		No	Subcarriers per physical resource block
`ofdm_symbols_in_slot`		No	OFDM symbols per slot
`antenna_config_max_gain_dBi`	dBi	Yes	Maximum antenna gain
`antenna_config_hor_phi_3dB_deg`	deg	Yes	Horizontal 3 dB beamwidth
`antenna_config_hor_alpha_mec_bearing_deg`	deg	Yes	Horizontal mechanical bearing angle
`antenna_config_hor_alpha_elec_bearing_deg`	deg	Yes	Horizontal electrical bearing angle
`antenna_config_ver_theta_3dB_deg`	deg	Yes	Vertical 3 dB beamwidth
`antenna_config_ver_beta_mec_downtilt_deg`	deg	Yes	Vertical mechanical downtilt angle
`antenna_config_ver_beta_elec_downtilt_deg`	deg	Yes	Vertical electrical downtilt angle
`antenna_config_gamma_mec_slant_deg`	deg	Yes	Mechanical antenna slant angle
`antenna_config_M`		No	Number of antenna elements (vertical rows)
`antenna_config_N`		No	Number of antenna elements (horizontal columns)
`antenna_config_P`		No	Antenna polarization (single or dual)
`antenna_config_number_of_elements`		No	Total number of antenna elements
`antenna_pattern_model`		No	Antenna pattern model
`antenna_config_Mg`		No	Antenna group rows
`antenna_config_Ng`		No	Antenna group columns
`antenna_config_P_type`		No	Antenna polarization type
`antenna_config_hor_A_m_dB`		Yes	Horizontal antenna attenuation limit
`antenna_config_ver_SLA_dB`		Yes	Vertical side lobe attenuation
`antenna_config_gamma_elec_slant_deg`		Yes	Electrical antenna slant angle
`antenna_config_dgh_m`		No	Horizontal antenna group spacing
`antenna_config_dgv_m`		No	Vertical antenna group spacing
`antenna_config_dh_m`		No	Horizontal antenna element spacing
`antenna_config_dv_m`		No	Vertical antenna element spacing
`BS_propagation_model`		No	Base station propagation model
`BS_fast_channel_model`		No	Fast channel model
`position_x_m`	m	Yes	Cell site X coordinate
`position_y_m`	m	Yes	Cell site Y coordinate
`position_z_m`	m	Yes	Cell site height (Z coordinate)

Carrier Management Parameters

get_carrier_management_config returns these fields for each cell, together with ID, name, site_ID, and site_name. set_carrier_management_config accepts partial updates for one or more cells before run_simulation.

Parameter	Type	Description
`cell_role`	enum	Cell role: `coverage` or `capacity`.
`paired_cell`	integer[]	Paired cell IDs from the read endpoint's `ID` column. An empty array clears the pairing.
`radio_enable_carrier_shutdown`	boolean	Enable the carrier-shutdown algorithm for the cell with JSON `true` or `false`.
`carrier_shutdown_currentCell_usage_threshold`	number	Finite PRB usage threshold below which a capacity cell shuts down.
`carrier_wakeUp_pairedCell__currentCell_usage_threshold`	number	Finite PRB usage threshold above which a coverage cell wakes its paired capacity cell.

UE Parameters

Parameter	Unit	Type	Description
`noise_figure_dB`	dB	numeric	UE receiver noise figure.
`UE_tx_power_max_dBm`	dBm	numeric	Maximum UE uplink transmit power.
`ue_target_rate_Mbps`	Mbps	numeric	Target data rate for UE traffic model.
`traffic_generation_model`		string	UE traffic generation model.
`category`		string	UE device category.