add documentation about using Artery for beginners

[riebl]

I think if the documentation covered the following topics as well, it would pave the way for beginners.

• [ ] load Artery project with OMNeT++ IDE (see #167)
• [x] set up VSCode for use with Artery (see #167)
• [x] how to add own scenarios
• [ ] use recorded data for X-distance-plots (X may be any metric, e.g. PER)

[awillecke]

Hi Raphael,

I've made some notes about setting up Artery with VS Code (https://github.com/awillecke/artery/wiki/Setting-up-Artery-in-VS-Code). The debugging configuration can definitively be improved by using the run_artery.sh to avoid manual changes, however, as a first draft it should be ok I guess.

Best regards Alex

[riebl]

Hi Alex!

That's Great! Are you okay if I add this information to Artery's documentation?

Best regards Raphael

[awillecke]

That's what it is intended for :)

[riebl]

@awillecke http://artery.v2x-research.eu/vscode/

[awillecke]

Hi Raphael,

here are some notes regarding the creation of scenarios and services: https://github.com/awillecke/artery/wiki/How-to-create-a-new-Service-and-Scenario-in-Artery

Best regards Alex

[riebl]

Thanks @awillecke, I have added a page based on your wiki entry: http://artery.v2x-research.eu/install/#next-create-your-own-simulation

[awillecke]

Except for the little typo (ccenario), I'm pleased with the restructuring and new formatting :smile: I hope it will ease the start for folks new to Artery.

[riebl]

Thanks for your hint; I have fixed it. What a pity…

[Enough7]

Hey, as someone new to artery I am missing an explanation on how to debug a simulation. Do you guys just attach gdb (like sudo gdb -p <pid>) or something else? Whats about nemiver which is sometimes mentioned in a dialog-window? It is an archived Repository and I can not get it to run because of missing dependencies. In one issue it is said to be not needed anymore. By which debugger is it replaced? I think that is a bit confusing.

[fysch]

Hi @Enough7, take a look at http://artery.v2x-research.eu/vscode/. I think that is the easiest way to debug Artery.

[Enough7]

Hi @fysch, thank you. That helped a lot. I somehow overlooked this part, even though I added the .json configs.

Is it normal that the GUI (Omnet++ in QTenv) does not start in debug mode? Because of this, I can not choose a specific configuration in the omnetpp.ini. I guess there is probably a flag? EDIT: I found

// OMNet++ config to run
"-cenvmod",

in launch.json

I also noticed that the highway-police scenario is commented out. That scenario freezes on start on my setup at least. So I wonder is this a known bug or is my build broken?

[fysch]

Is it normal that the GUI (Omnet++ in QTenv) does not start in debug mode? Because of this, I can not choose a specific configuration in the omnetpp.ini. I guess there is probably a flag?

Are you sure it Omnet++ is not in debug mode? The reason you can't choose a config is because of the -cenvmod and -r0 args (config with name "envmod" and run number 0). You can remove them if you want to choose config and run manually.

I also noticed that the highway-police scenario is commented out. That scenario freezes on start on my setup at least. So I wonder is this a known bug or is my build broken?

Where exactly does it freeze? Do you get any error message?

[Enough7]

It freezes on clicking start, running the sumo-gui config. I may open a new issue for this.

Are you sure it Omnet++ is not in debug mode?

I guess it is in debug mode.

[riebl]

Is your debugger maybe simply stopping at a breakpoint? Then, the GUI is freezing, obviously.

[awillecke]

Since the example .launch.json requires some manual adjustments, it may also be not configured correctly. The terminal in VS Code should give some more information what may be faulty. Can you the post relevant parts?

In the future, this config could potentially be built by CMake similar to the run_artery.sh to overcome this issue.

[Enough7]

Is your debugger maybe simply stopping at a breakpoint? Then, the GUI is freezing, obviously.

When I run

cmake --build build --target run_highway_police

and choosing the sumo-gui config, it still freezes. It seems to be an initialization issue or an early simulation start issue.

[riebl]

Can you start sumo-gui as a standalone application? I have experienced such a freezing behaviour when sumo-gui failed for some reason, e.g. missing shared libraries.