Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc correction #2387

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Doc correction #2387

wants to merge 4 commits into from

Conversation

harrahx3
Copy link

@harrahx3 harrahx3 commented Sep 2, 2024

I found small errors in the doc:

  • For the lines the parameter x_ohm_per_km corresponds to the reactance of the line and not its inductance (else the unit would have been h_per_km)
  • In the docstring of the create_load and create_loads functions the parameter p_mw was described as optional and defaulting to 0, but it is not (but maybe it should ?)

Also there is a contradiction between the comment in this docstring that says that a negative load can be used to model a static generator, and the note in the documentation: "Loads should always have a positive p_mw value, since all power values are given in the consumer system. If you want to model constant generation, use a Static Generator (sgen element) instead of a negative load.".

Is using a load with a negative p_mw equivalent to using a sgen element or is there any difference between the two (apart from the power signing convention) ?

harrahx3 and others added 4 commits September 2, 2024 14:00
Change x_ohm_per_km description from inductance to reactance
p_mw is actually a required argument of create_load and create_loads functions
Fix style
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant