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

Rename "nominal_value" of Flow #991

Closed
p-snft opened this issue Oct 12, 2023 · 4 comments · Fixed by #1114
Closed

Rename "nominal_value" of Flow #991

p-snft opened this issue Oct 12, 2023 · 4 comments · Fixed by #1114
Assignees
Milestone

Comments

@p-snft
Copy link
Member

p-snft commented Oct 12, 2023

For Flow, we have the keyword nominal_value. I think, the capacity of a Flow (e.g. a power line) is actually easier to interpret as the "nominal value". Actually, I have been asked that quite some times. If we have a nominal_capacity of a Flow, it would be arguable why it's nominal_storage_capacity for the GenericStorage. So we need to say either nominal_flow_capacity which is actually redundant. In my opinion, it makes sense to call both nominal_capacity.

In fact, they are quite similar. In particular, they both accept a number (fixed capacity) or an Investment object.

@upadhayaajay
Copy link

I occasionally find it confusing; using the name nominal_value seems less intuitive. It might make more sense to name it nominal_capacity as you suggested, providing a clearer indication of its meaning. I agree with your suggestion to rename both to nominal_capacity.

_

@p-snft p-snft self-assigned this Aug 2, 2024
@p-snft
Copy link
Member Author

p-snft commented Aug 2, 2024

I still have to keep explaining people what the nominal_value is meant for and they just understand if I name it nominal_capacity, instead. I think, we should really do this.

@p-snft p-snft added this to the minor release milestone Aug 22, 2024
@p-snft p-snft linked a pull request Aug 22, 2024 that will close this issue
@lensum
Copy link
Contributor

lensum commented Nov 27, 2024

I agree that nominal_capacity would be an easier-to-understand term for the nominal_value in the flow. In fact, we already use this term in the documentation of the full_load_time_max and full_load_time_min. However, I also think that it could be confusing to have nominal_capacity describe (simplified) the power of a flow, while the nominal_storage_capacity in the GenericStorage is an energetic quantity and not a power quantity.
Would it be enough to include good documentation on the nominal_storage_capacity? Because I can't think of a better term than "capacity" to describe both quantities (see also this Wikipedia Article that lists terminology, but most of them end in "capacity"). I guess users that don't read the documentation carefully could be confused. Though maybe this is something we have to live with?

@p-snft
Copy link
Member Author

p-snft commented Nov 27, 2024

I guess that users that do not consciously distinct power and energy will stumble upon the different time index at some point. In my opinion, the new introductions (#1141) should be very distinct here. Also, the new result processing (cf. #1138) might make the difference clearer by not using these different types of data with the same index (that they in fact do not share).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants