Water Data Unit Conversions 🔢 (addendum to #336)

[Wegatriespython]

Automatic Unit Conversions for Water Data

Builds on the DSL refactor from PR #336. Adds a unit conversion layer with automatic constants and value scaling. With dimensionality checks.

Conversion logic is modular, can be updated with pint or iam_units. Automatic conversion in the sense when the units for a value are changed, the value and any constants used its calculation are automatically scaled.

How to review

• Check GDX to see if unit conversion is consistent
• Questions on use and functionality
• Ensure that changes/additions are self-documenting

PR checklist

• Continuous integration checks all ✅
• Add or expand tests; coverage checks both ✅
• Add, expand, or update documentation.
• Update doc/whatsnew.

[codecov]

Codecov Report

Attention: Patch coverage is 82.31293% with 312 lines in your changes missing coverage. Please review.

Project coverage is 77.7%. Comparing base (ae0cf78) to head (74f6679).
Report is 561 commits behind head on main.

Files with missing lines	Patch %	Lines
...essage_ix_models/model/water/data/water_for_ppl.py	20.6%	185 Missing ⚠️
message_ix_models/model/water/data/demands.py	83.4%	39 Missing ⚠️
message_ix_models/model/water/data/water_supply.py	86.2%	27 Missing ⚠️
message_ix_models/model/water/dsl_engine.py	87.5%	18 Missing ⚠️
message_ix_models/model/water/rules.py	88.5%	16 Missing ⚠️
...age_ix_models/tests/model/water/test_dsl_engine.py	86.9%	12 Missing ⚠️
message_ix_models/util/citation_wrapper.py	78.5%	6 Missing ⚠️
...ix_models/tests/model/water/test_dsl_engine_pt2.py	97.5%	5 Missing ⚠️
message_ix_models/model/water/utils.py	80.0%	1 Missing ⚠️
...dels/tests/model/water/data/test_infrastructure.py	75.0%	1 Missing ⚠️
... and 2 more

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #343     +/-   ##
=======================================
- Coverage   78.5%   77.7%   -0.9%     
=======================================
  Files        216     227     +11     
  Lines      17409   18655   +1246     
=======================================
+ Hits       13679   14504    +825     
- Misses      3730    4151    +421     

Files with missing lines	Coverage Δ
message_ix_models/model/water/data/demand_rules.py	100.0% <100.0%> (ø)
...ssage_ix_models/model/water/data/infrastructure.py	100.0% <100.0%> (ø)
...ix_models/model/water/data/infrastructure_rules.py	100.0% <100.0%> (ø)
message_ix_models/model/water/data/irrigation.py	100.0% <100.0%> (ø)
...age_ix_models/model/water/data/irrigation_rules.py	100.0% <100.0%> (ø)
..._ix_models/model/water/data/water_for_ppl_rules.py	100.0% <100.0%> (ø)
...e_ix_models/model/water/data/water_supply_rules.py	100.0% <100.0%> (ø)
...e_ix_models/tests/model/water/data/test_demands.py	100.0% <100.0%> (ø)
...models/tests/model/water/data/test_water_supply.py	100.0% <100.0%> (ø)
message_ix_models/tests/model/water/rules_test.py	100.0% <100.0%> (ø)
... and 12 more

... and 16 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Wegatriespython]

superseded by nexusSSP6