diff --git a/How-to-run.md b/How-to-run.md index 189e57b..c2fe0db 100644 --- a/How-to-run.md +++ b/How-to-run.md @@ -1,21 +1,20 @@ # How to run -This application can be launched from an IDE, or from a shell (linux or Windows). +This application can be launched from an IDE, or from a shell (linux, Windows, Mac). You will need a config.json configuration file (see [default_config.json](https://github.com/Ahp06/SUMO_Emissions/blob/master/sumo_project/configs/default_config.json) for a template) and a simulation file. You can use your own scenario file (osm.sumocfg file), see : [SUMO Tutorials](http://sumo.dlr.de/wiki/Tutorials). **With a Shell:** -`> py ./emissions.py [-h] [-f CONFIGFILE] [-save] [-ref] [-steps STEPS]` +![](https://github.com/Ahp06/SUMO_Emissions/blob/master/sumo_project/files/imgs/runner_help.PNG) -* [-h] : Commands help -* [-f CONFIGFILE] : Choose your configuration file from your working directory -* [-save] : Save the logs, by default logs will be in the logs file in the working directory with this format: -`sumo_project/logs/sumo_logs_{current_timestamp}.log` -* [-ref] : Launch a reference simulation (without acting on infrastructure and vehicles -* [-steps STEPS] : Choose the simulated time (in seconds) +Example : + +![](https://github.com/Ahp06/SUMO_Emissions/blob/master/sumo_project/files/imgs/runner_example.PNG) + +This command will create a new dump "dump1" with the configuration file "config" +and the simulation will be launched with CSV data export and logs backup. -Ex : `> py ./emissions.py -f configs/your_config.json -save -ref`