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

Revision/rename nominal value #1114

Open
wants to merge 19 commits into
base: dev
Choose a base branch
from
Open

Conversation

p-snft
Copy link
Member

@p-snft p-snft commented Aug 22, 2024

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.

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. Reflecting a bit, the capacity of a Flow (e.g. a power line)
is easier to interpret as the "nominal value". Thus the refactoring.
This way, it is analogue to teh keyword of the Flow.
@p-snft p-snft linked an issue Aug 22, 2024 that may be closed by this pull request
@p-snft p-snft self-assigned this Aug 22, 2024
@p-snft p-snft added this to the major release milestone Aug 22, 2024
@p-snft p-snft marked this pull request as ready for review August 22, 2024 14:16
@p-snft p-snft requested a review from a team August 27, 2024 09:36
Copy link
Member

@jokochems jokochems left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@p-snft I had a look and introduced some fixes and suggestions.

I have some doubts concerning the renaming for the storage which is a consequence of the fact that the English term "capacity" similarly to the German term "Kapazität" can have different meanings.

For storages, we have a value in MWh, while for flows, we have a value in MW or whatever energy resp. power unit. Both are named "capacity", though, which might be slightly misleading, esp. for unexperienced users.

Maybe, one idea would be to rename to something like nominal_energy for storages to make the physical dimensions clearer.

But anyways, feel free to decide on how to proceed with the renaming.

docs/whatsnew/v0-6-0.rst Outdated Show resolved Hide resolved
examples/tuple_as_labels/tuple_as_label.py Outdated Show resolved Hide resolved
examples/tuple_as_labels/tuple_as_label.py Outdated Show resolved Hide resolved
examples/tuple_as_labels/tuple_as_label.py Outdated Show resolved Hide resolved
tests/test_components/test_storage.py Show resolved Hide resolved
tests/test_flows/test_simple_flow.py Outdated Show resolved Hide resolved
@p-snft
Copy link
Member Author

p-snft commented Nov 25, 2024

@p-snft I had a look and introduced some fixes and suggestions.

I have some doubts concerning the renaming for the storage which is a consequence of the fact that the English term "capacity" similarly to the German term "Kapazität" can have different meanings.

For storages, we have a value in MWh, while for flows, we have a value in MW or whatever energy resp. power unit. Both are named "capacity", though, which might be slightly misleading, esp. for unexperienced users.

Maybe, one idea would be to rename to something like nominal_energy for storages to make the physical dimensions clearer.

But anyways, feel free to decide on how to proceed with the renaming.

Storages only have energy, Flows only have power. Thus, I think harmonisation is more beneficial than having different names. For both, the name is "nominal_capacity", both accept a value or an Investment object. Also, "energy" should not be a keyword. In fact, we do not enforce units. For example, you could have a storage with a certain mass of hydrogen or wood pallets. It still represents energy, but the unit does not match (we are off by a factor c² XP).

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

Successfully merging this pull request may close these issues.

Rename "nominal_value" of Flow
2 participants