POST vpz/experiment

Resource URL

http://erecord.toulouse.inra.fr:8000/vpz/experiment

Description

Modifies the experiment conditions of a simulator (see input information of a vpz) according to the experiment plan defined into the posted file. In addition with this experiment conditions modification (mandatory posted file), maybe modifies the input datas folder of the simulator according to another posted file (optional). Then runs the simulation, produces and returns a file containing the simulation results (see output information of a vpz) and also the experiment conditions (see input information of a vpz).

Details

jwt
If the simulator is in limited access then authentication is required, by a ‘jwt’ parameter containing an available JWT value.

posted (and returned) file of experiment plan (and simulation results)

The posted file is a xls file given by the user into the POST request (HTTP multipart request) as ‘experimentfile’ parameter (see below The posted file (experimentfile parameter)).

The returned file is a xls file (see below The returned file).

input datas folder
The file (optional) posted to modify the input datas folder is a zip file given by the user into the POST request (HTTP multipart request) as ‘datafolder’ parameter. The way how this zip file content is taken into account depends on the ‘datafoldercopy’ parameter value.

Help

See an example as help on how to know the simulators that can be chosen with the ‘vpz’ option.

Before a POST vpz/experiment command, it may be useful to do a GET vpz/experiment command in order to easierly build the xls file that is required into POST vpz/experiment request. Indeed :

Request parameters

Required : either vpz or vpzpath must be provided.

Required : experimentfile.

Required : jwt in limited access case.

The posted file (experimentfile parameter)

The posted xls file of the POST vpz/experiment request has the same format and structure than the xls file returned by the GET vpz/experiment request.

The posted xls file contains the experiment conditions from which the simulator has to be updated :

  • General information : plan (‘single’ or ‘linear’ values), restype (‘dataframe’ or ‘matrix’ values), begin, duration.
  • Parameters values : list of the parameters values to be modified (the unchanged values may remain but it is not necessary).
  • Parameters identification : list of the parameters to be given into the returned file.
  • Output datas identification : list of the output datas to be given into the returned file.

Example of a posted xls file

Response result

The returned result is a file report about both VpzOutput and VpzInput.

The returned file

The returned xls file contains the simulation results and experiment conditions of the simulator modified according to the posted file :

  • Simulation results :

    Values array(s) of the selected output datas.

  • Experiment conditions :

    • General information : plan, restype, begin, duration according to the posted file information.
    • Parameters values : list of the selected parameters values according to the posted file information.
    • Parameters identification : list of the selected parameters.
    • Output datas identification : list of the selected output datas.

Only the selected output datas and parameters are present into the returned file :

  • a parameter is selected if it has been declared into the posted file, in the dedicated list “Parameters identification”.
  • an output data is selected if it has been declared into the posted file, in the dedicated list “Output datas identification”.

Limit : in case of xls file overflow (sheets limited to 256 columns and 65536 rows) the results will be truncated (without any warning).

Example of a returned xls file

Example

Example : In command line with cURL

Example : in menus under the page Select, modify and run a simulator, the ‘Third step : send your own experiment plan’ consists in a POST vpz/experiment request. Try.

More

This resource is part of Web API ‘vpz’