Dimosim interactive API tester
variables
documentation
Optional arguments
Show control variables only
Show output and result variables for project only
Optional files
Thermal zones - tz_file
The file containing the description of the district, including geometry and zoning (e.g.
demand_zone.json
is an example without network, while
systems_zone.json
requires to upload all optional files, too)
Optional files required for simulations with networks
Parameters - parameter_file
Optional parameter file using '*' notation (e.g.
systems_parameter.json
)
This file is required (not optional) if a hydraulic network is used (e.g. buildings with substations), because it will allow to define the generator parameters.
District hydro-distribution - dhd_file
Optional json file defining the geometry of the district heating network (e.g.
district_hydro_distribution.json
)
This file is required (not optional) if a hydrolic network is used (e.g. buildings with substations)
District generator - dg_file
Optional json file defining the generators and their location (e.g.
district_multi_generator.json
)
This file is required (not optional) if a hydrolic network is used (e.g. buildings with substations)
Note:
Just push the run button (do not specify a geojson or parameter file) to obtain a list of
all
possible variables as a json object.
The json object provides:
ids
: a list of the IDs of all objects created in the project. This requires attaching a .geojson file
parameter_variables_list, parameter_variables_tree
: default values for all existing objects; they can be pasted into the parameter_file (under the id of any geojson object to modify its default values or under a "*" to modify all objects) when running a simulation with a geojson file.
results
: names of all result variables (including units and description) available at the end of the simulation. Time series (one value per timestep) have the word '... vector' in their description
external_control
: lists information accessible during co-simulation (exchange of values at every timestep):
input_variables
inside the external_control tag: values that can be send to Dimosim via a socket while a simulation using the external_control object is running
output_variables
inside the external_control tag: values that can be received by a client over a socket while a simulation using the external_control object is running
When using external control, you can copy-paste the
input_variables
and
output_variables
tags into the
external_control
section of your parameter_file.
specify a geojson file and push the run button to obtain
a list of parameter variables specific to
your
project. You can add this to your project's parameter_file (using wildcards to apply to all objects, or a specific object using its ID in the parameter_file). The variables are provided as a list under
parameter_variables_list
and grouped by object type under
parameter_variables_tree
. The parameter_variable_tree also provides ids for objects (to allow for modification of individual objects) als well as parent (container) ids (to allow for modification of a group of objects, such as all ExteriorWalls contained in a ThermalZone).
a list of all object IDs under the
ids
tag
specify a geojson and parameter_file with wildcards to obtain a list of object names (e.g. ThermalZone names) for your project. If both files are given,
a modified (expanded) version of your parameter_file will be returned
if the parameter_file contains an external_control
tag
a variable list will be returned if the parameter_file does not contain an external_control tag (use e.g. for networks)