71e19fd747 | ||
---|---|---|
.. | ||
README.md | ||
config_example.json |
README.md
Structure
The configuration file is divided in 3 main blocks,
arguments
simulation
plotting
These blocks will be explained below. Also, an example of a configuration file is given under the shared
folder.
arguments
block
Here we can establish the parameters related with the results of the simulation.
output-format
Description: Format of the resulting data of the simulation. This will be used to set the name of the files created by the simulation in the manner output-file + "_seedUsed." + output-format.
Possible values:
csv
parquet
json
Type: string
Required: No
Default value: parquet
Example:
{
"output-format": "csv"
}
output-file
Description: Name of the file that will contain the results. It will be created inside the host shared folder. This will be used to set the name of the files created by the simulation in the manner output-file + "_seedUsed." + output-format.
If an output folder is given, the files will be created inside that folder.
Type: string
Required: Yes
Example:
{
"output-file": "test"
}
output-folder
Description: Folder to save the results and/or plots of the execution. It will be created inside the host shared folder.
Note /!: If a folder will the same name exists, it will be deleted with all it's content.
Type: string
Example:
{
"output-folder": "results"
}
number-of-simulations
Description: Number of simulations that will be done under the same configuration. Each simulation will be different, as a different seed will be used per simulation.
Type: integer
Required: Yes
Example:
{
"number-of-simulations": 100
}
Full arguments example:
{
"output-format": "csv",
"output-file": "test",
"output-folder": "folder",
"number-of-simulations": 3
}
simulation
Here we will set the simulation parameters, depending on the simulation we want to do. These parameters are explained in their own repository.
- Snow family (default)
Plotting (to-do)
Plotting part of the configuration file. These plots are being done with Seaborn.
First example:
Description: Scatter plot.
Possible values: Any value will be mapped to the scatterplot method.
Type: dict
Example:
{
"scatterplot": {
"plot_options": {
"x": "id",
"y": "vote"
},
"save_options": {
"name": "test2.png"
}
}
}
TEMPLATE:
Description:
Possible values:
- ``
- ``
Type: **
Required: **
Default value: ``
Example:
{
}