search

CURENT / andes

Python toolbox / library for power system transient dynamics simulation with symbolic modeling and numerical analysis 🔥
https://ltb.curent.org
Other
224 stars 111 forks source link

Documentation: Change TDS timeframe in interactive usage #283

Closed MaKla89 closed 2 years ago

MaKla89 commented 2 years ago

While changing the simulation timeframe is very straightforward and simple for CLI-usage (as it is part of the cheatsheet :) ) I had a somewhat unnecessarily hard time to find out how to change the simulation time in interactive usage:

ss = andes.run('./cases/5bus/pjm5bus.xlsx', tf=50)

The solution is stunningly simple, but somehow I had to figure this out with trial and error as the documentation did not mention this setting anywhere else but in the configuration params (while not telling how to apply config-changes). I'm not very savvy, thus this request might be fairly stupid, but maybe other users struggled with this, too :)

Great work, very user-friendly otherwise!

cuihantao commented 2 years ago

Thanks a lot for the suggestion, and sorry for the incomplete documentation.

Did you get a chance to check out the example Jupyter notebooks? They are linked at the end of the tutorial in a short paragraph. One of the examples mentioned how to set a stopping time and then resume simulations.

I will also update the tutorial soon.

Regards, Hantao Cui On Mar 2, 2022, 4:03 AM -0600, MaKla89 @.***>, wrote:

While changing the simulation timeframe is very straightforward and simple for CLI-usage (as it is part of the cheatsheet :) ) I had a somewhat unnecessarily hard time to find out how to change the simulation time in interactive usage: ss = andes.run('./cases/5bus/pjm5bus.xlsx', tf=50) The solution is stunningly simple, but somehow I had to figure this out with trial and error as the documentation did not mention this setting anywhere else but in the configuration params (while not telling how to apply config-changes). I'm not very savvy, thus this request might be fairly stupid, but maybe other users struggled with this, too :) Great work, very user-friendly otherwise! — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you are subscribed to this thread.Message ID: @.***>

MaKla89 commented 2 years ago

Ah no, I did not check that out yet as I usually don't use Jupyter notebooks. It's absolutely not very important to change, but it seemed like a very basic and relevant parameter for people to play around with. Thats why I was a bit lost as in "this cannot be too hard, come on, be smarter!!" ;)

Thanks for your reply and your work!

cuihantao commented 2 years ago

Updated the docs in https://github.com/cuihantao/andes/commit/139ae2565891d13a9ce854cc7af6e00dce7c02a2 and added all examples to the documentation in a new section called "Scripting Examples". Hope this will reduce efforts to jump between the tutorial and examples.

It's in the latest of the docs but will make it into stable soon. See https://docs.andes.app/en/latest/index.html

Again, thanks for the feedback. Any further comments please let me know.