Dimosim interactive API tester

run-from-geojson

Data

start_time		Start time of the simulation. Please use the format given in the example.
timestep_length		Length of one timestep. '1H' means values will be computed every hour. To specify the timestep in minutes, use 10min
duration (#timestep)		Duration of the simulation (same format as timestep_length)
weather_file_source		One of ASHRAE, EnergyPlus or METEO_RT2012. To use your own weather file, upload a file below under 'Optional files', 'Custom weather file'.
weather_file		The weather data file in the format specified under weather_file_source. To use your own weather file, upload a file below under 'Optional files', 'Custom weather file'.
time_zone of weather data		pytz timezone such as 'Europe/Paris' (pytz.all_timezones lists all)
simulation_uuid		Unique ID for the simulation project. You can use this ID to check the status of your simulation (using /ping) or stop the simulation (using /kill). If several runs have the same ID, /ping or /kill operations will apply to all.
access_token		The password which allows you to run simulations on our server. Please contact CSTB to get one.
study_key		An ID describing the simulation. It is currently only used as a comment in the Web version of the API.
simulation_type		Not currently used in the Web version of the API.
target		The format used to store results if realtime-dumping to a database is configured. Use csv for Web simulation, json or hdf for API calls in connection with an arrango data base, json_s3 or hdf_s3 for Amazon s3 bucket storage.
db_result_schema		Name of the database schema (e.g. Results, ExternalsResults). Not used in the web version of the API.
class_name		Results will be stored starting from this class down the class hirarchy. Keep GenericObject to be able to retrieve all results.
result_list		List of results to be stored. Results can also be conveniently defined in the parameter_file (see below).

Files

Thermal zones - tz_file

The file containing the description of the district, including geometry and zoning (e.g. tz_file_demand.geojson). To define results, attach a parameter file below.

Optional files

District parameters - parameter_file		Optional json file which allows to modify default values for all simulated objects and define required results (e.g. parameter_file_with_results.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. This files also allows to compose scenarii, like in this example.
District hydro-distribution - dhd_file		Optional json file defining the geometry of the district heating network (e.g. dhd_file.json) This file is required (not optional) if a hydraulic network is used (e.g. buildings with substations)
District generator - dg_file		Optional json file defining the generators and their location (e.g. dg_file.json) This file is required (not optional) if a hydraulic network is used (e.g. buildings with substations)
Custom weather file - custom_weather_file		Weather data file (e.g. Paris.epw). EnergyPlus weather files are available here.
Scenario - scenario_file		Optional json file allowing to define profiles such as electric load (e.g. scenario_file.json). Use /variables to find possible variables.