Simulation input parameters

Global

serverUrl

String

The Bloonet Web Services host server

mapdata

name

String

The map data name, must be unique

layers.path

String

The path to the map data layer, relative to the web service (see installation guide)

layers.layerType

String

The layer type. The list is described in the API document.

layers.layerFormat

String

The layer format. The list is described in the API document.

epsgSrid

Integer

The projection code following the EPSG

antennas

name

String

The antenna name, as set in the csv file. Several antennas can be listed.

antennaFile

String

Relative path to the antenna diagram file

session

name

String

The calculation session name

models

name

String

The model name, as set in the csv file. Several models can be entered

vxfFilePath

String

Relative path to the model VXF file

mapdataName

String

The mapdata linked to the model. Must be a mapdata name set in Mapdata section.

description

String

Description of the propagation model (optional)

facadeIncidenceAngleContent

String

Loss according to angle.
prediction_along_building_facade has
to be in true value.
Content: “Number of lines to read\n
Angle_1 Loss_1\nAngle_N Loss_N »"
Number of lines to read= Integer
Angle=[0-90] degree in decimal
Loss= dB in decimal
(optional)

predictionSettings

networkFile

String

Relative path to the CSV network file

predictionResultType

String

Array of required outputs. The list of available outputs is described in this section

receptionHeights

Array of BigDecimal

The list of reception heights, in meters.

receptionHeightReference

String

GROUND or CLUTTER

force

Boolean

Boolean to force the calculation of the prediction

isotropic

Boolean

False by default. Set to true for 5G computations. Forces the set of the antennas to emit as an isotropic antenna

priority

Int

0 by default. Negative values are accepted. Prediction with the highest value priority will be run first.

type

String

Defined the type of simulation computed.
By default, it is AREA.
Value possible: AREA, POINT

shiftGridCenter

Boolean

False by default. Allows to align the grids on the Atoll results. Must be used for the conversion script in ".los" format.

deleteTempDir

Boolean

False by default. If True, erase volcano temporary file.

deleteScenariiDir

Boolean

False by default. If True, erase scenarii folder inside Docker.

volcanoOutputs

Boolean

False by default. Allows to generate VIF/VRF outputs from volcano per prediction in the API.

outputPath

String

Relative path to the output folder, where results are downloaded

network

computationType

String

The selected system calculation type. The list is: Custom, 4G, 5G

computationResultType

String

Array of required outputs. The list of available outputs is described in this section

computationZone

A filtering area for post processing results defined by its coordinates (bounding box and resolution) and its projection code.

computationZone.xmin

BigDecimal

null to disable feature

computationZone.xmax

BigDecimal

null to disable feature

computationZone.ymin

BigDecimal

null to disable feature

computationZone.ymax

BigDecimal

null to disable feature

computationZone.filterShape

String

Path to ".shp" file for filtering postprocessing zone.

computationZone.epsgCode

Integer

null to disable feature

resolution

BigDecimal

In meters

dynamicParameters

System calculation specific parameters. These parameters are listed below

coordinates

A filtering area defined by its coordinates, in the map data coordinate system (bounding box)

coordinates.xmin

BigDecimal

In meters

coordinates.xmax

BigDecimal

In meters

coordinates.ymin

BigDecimal

In meters

coordinates.ymax

BigDecimal

In meters

repeaterSeparated

Boolean

Allow to download best server result with repeaters separated

kmz

Parameters associated with KMZ format outputs

kmz.palette

String

Value of the color palette used for KMZ outputs. Possible values: viridis, inferno, magma, plasma, rainbow and reversedrainbow

kmz.min

Integer

Minimum values to apply to the best signal output in KMZ format

kmz.max

Integer

Maximum values to apply to the best signal output in KMZ format

transmitter id

Integer

Unique in the network. Mandatory for post processing

transmitter name

String

transmitter easting

Meters

BigDecimal

To value with transmitter northing. Cannot be combined with transmitter longitude/transmitter latitude

transmitter northing

Meters

BigDecimal

To value with transmitter easting. Cannot be combined with transmitter longitude/transmitter latitude

transmitter longitude

Degrees

Decimal

To value with transmitter latitude. Cannot be combined with transmitter easting/transmitter northing

transmitter latitude

Degrees

Decimal

To value with transmitter longitude. Cannot be combined with transmitter easting/transmitter northing

transmitter height

Meters

BigDecimal

Relative to ground

azimuth

Degrees

Decimal

0 degrees for north, increase clockwise

0

downtilt

Degrees

Decimal

0 degrees for horizontal, increase clockwise

0

additional electrical downtilt

Degrees

Decimal

0 degrees for horizontal, increase clockwise

0

frequency

MHz

Decimal

antenna

String

Name of the antenna to use for the cell prediction

Isotropic

propagation model

String

Name of the Volcano propagation model to use for the cell prediction

emitting power

dBm

Decimal

0

comments

String

terrain altitude

Meters

BigDecimal

Optional. Manually set the altitude height instead of taking into account the DTM height

If empty, DTM altitude height is considered

epre offset ss vs rs

dBm

Decimal

Mandatory, if SINR computation is in mode Advanced

epre offset pbch vs rs

dBm

Decimal

Mandatory, if SINR computation is in mode Advanced

epre offset pdcch vs rs

dBm

Decimal

Mandatory, if SINR computation is in mode Advanced

epre offset pdsch vs rs

dBm

Decimal

Mandatory, if SINR computation is in mode Advanced

number antenna ports

Integer

Mandatory, if SINR computation is in mode Advanced. Value range: [1;2;4;8;16;32;64;128]

multi antenna interference factor

Integer

Optional, if SINR computation is in mode Advanced. Value range: [1; +∞ [

1

calculation resolution

Meters

Integer

calculation radius

Meters

Integer

calculation radius extended

Meters

Integer

Mandatory for Main-Extended computation

calculation resolution extended

Meters

Integer

Mandatory for Main-Extended computation

propagation model extended

String

Name of the Volcano propagation model associate to Extended area

If empty, propagation model considered

additional antennas N

Name

String

The additional antenna name associate to the antenna number N

additional antennas N azimuth

Degrees

Decimal

0 degrees for north, increase clockwise

0

additional antennas N downtilt

Degrees

Decimal

0 degrees for horizontal, increase clockwise

0

additional antennas N additional electrical downtilt

Degrees

Decimal

0 degrees for horizontal, increase clockwise

0

additional antennas N percentage

Integer

Value range: [0-100]

repeat transmitter id

Integer

Must be set to an existing transmitter id in the file to enable repeater feature

donor loss

dB

BigDecimal

Loss in dB applied from the donor transmitter. The transmission power of the repeater is the transmission power of the donor from which we subtract the donor loss

techno

String

4G

trafficload

Decimal

Value range: [0-1]

0

techno

String

5G

antenna CSI

String

Name of the CSI GOB antenna to use for the 5G postprocessing

antenna SSB

String

Name of the SSB GOB antenna to use for the 5G postprocessing

trafficload

Decimal

Value range: [0-1]

0

receiver name

String

receiver easting

Meters

BigDecimal

receiver northing

Meters

BigDecimal

receiver height

Meters

BigDecimal

Relative to ground

receiver antenna

String

Optionnal

If empty, Antenna Isotropic is defined

receiver azimuth

Degrees

Decimal

0 degrees for north, increase clockwise

0

receiver downtilt

Degrees

Decimal

0 degrees for horizontal, increase clockwise

0