search

GMLC-TDC / HELICS-Tutorial

Tutorial of running a HELICS Co-Simulation
http://gmlc-tdc.github.io/HELICS-Tutorial
BSD 3-Clause "New" or "Revised" License
3 stars 7 forks source link

Tutorial 2 not working with HELICS v2 #10

Open ryangilmour opened 4 years ago

ryangilmour commented 4 years ago

Tutorial 2 is not working with HELICS v2.

A previous pull request was submitted to update Tutorial 1 to work with HELICS v2, but nothing further than this. I suspect it means that tutorials 3-5 are also not working on v2, but this has not been checked.

By altering tutorial 2 to correspond to tutorial 1 (i.e. changing the non-working HELICS commands within federate1.py) allows the code to be run using the following commands:

$ helics_broker -f 2 --loglevel=3 --name=mainbroker
$ helics run --path config.json

The tutorial suggests that the only command needed to set the simulation running is

$ helics run --path config.json

I suspect this is how the example is supposed to work, but I am not sure. So maybe this means there is another issue in there, where the config.json file is not creating a broker correctly. Help on this would be appreciated.

I have made the changes previous made to tutorial 1, to tutorial 2, and could create a new branch for this. Do I need any special permission to do this?

kdheepak commented 4 years ago

Thanks for posting, we've been meaning to clean up this tutorial repository but haven't gotten around to it yet.

There's a few things going on here:

that tutorials 3-5 are also not working on v2

This is true, but the changes to the Python files are the same changes that need to be made that you made for tutorial 2.

I suspect this is how the example is supposed to work, but I am not sure.

This is also correct, but the latest version of helics-cli run does not respect the broker: true flag. This is a known issue, and I am working on fixing it.

I have made the changes previous made to tutorial 1, to tutorial 2, and could create a new branch for this.

If you can make a branch for this that would be great! We'b be happy to review and merge. You'll need to fork this repository, make your changes in a branch and submit a new PR.