Skip to content

Rename alpha_w_per_m2k to u_w_per_m2k - #720

Open
dad616610 wants to merge 11 commits into
e2nIEE:developfrom
dad616610:rename_alpha_to_u
Open

Rename alpha_w_per_m2k to u_w_per_m2k#720
dad616610 wants to merge 11 commits into
e2nIEE:developfrom
dad616610:rename_alpha_to_u

Conversation

@dad616610

Copy link
Copy Markdown
Contributor

This PR completes the renaming of the heat transfer coefficient parameter from alpha_w_per_m2k to u_w_per_m2k to align with standard thermodynamic notation (U = overall heat transfer coefficient). The changes include:

  • Parameter renaming and description updates
  • branch index synchronization (ALPHA to U)
  • Documentation fixes
  • Selective test updates (preserving deprecation tests)

Key changes

Parameter updates

  • Renamed alpha_w_per_m2k to u_w_per_m2k throughout codebase
  • Updated parameter description from "heat transfer coefficient" to "overall heat transfer coefficient"
  • Changed branch index from ALPHA to U

Documentation:

  • Updated all references in docs to reflect u_w_per_m2k and new description

Test Updates:

  • Modified tests that used alpha_w_per_m2k syntax to use u_w_per_m2k (modified test_heat_consumer.py)
  • Preserved tests checking deprecation path for alpha_w_per_m2k (unchanged)

@EPrade EPrade left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, thank you! Could you also add a changelog entry?

@dad616610

Copy link
Copy Markdown
Contributor Author

Done!

@EPrade

EPrade commented Jul 14, 2025

Copy link
Copy Markdown
Contributor

Could you solve the merge conflicts please? Then we would merge the PR. Thanks!

@dad616610
dad616610 force-pushed the rename_alpha_to_u branch from fdda132 to 38031e1 Compare July 16, 2025 18:01
@dad616610

Copy link
Copy Markdown
Contributor Author

Apologies for expanding the scope right before merge - I noticed the variable naming inconsistency during rebase and felt it was worth addressing now for consistency.

I've rebased to resolve conflicts and:

  • Renamed alpha (heat transfer context) to u_overall in:
    src/pandapipes/converter/stanet/table_creation.py
    src/pandapipes/pf/derivative_calculation.py
  • Updated CSV field names in src/pandapipes/test/data/Temperature_*

Open questions:

  1. Network files (src/pandapipes/networks/network_files/* with alpha_w_per_m2k):
    Rename to u_w_per_m2k?
  2. Legacy tests (src/pandapipes/test/api/old_versions/*):
    Preserve alpha_w_per_m2k for compatibility?

@SimonRubenDrauz

Copy link
Copy Markdown
Collaborator

Thanks for your contribution. Regarding your two questions see my answers below:

  1. Agree! Renaming would make sense!
  2. Legacy tests should keep alpha_w_per_m2k, as this structure is expected in older versions. Therefore, preserve the structure!

@dad616610

Copy link
Copy Markdown
Contributor Author

Done! I've renamed the network files as suggested. Please let me know if it looks good!

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.

3 participants