Converter¶
Model input conversion and validation for optimization.
This module bridges LCA data processing and optimization by converting outputs from LCADataProcessor into structured OptimizationModelInputs. It provides validation, scaling, serialization, and constraint management for optimization model inputs.
Key Classes¶
OptimizationModelInputs: Validated data structure for optimization inputsModelInputManager: Handles conversion, serialization, and constraint overrides
Module Reference¶
Model input conversion and validation for optimization.
This module bridges LCA data processing and optimization by converting outputs from LCADataProcessor into structured OptimizationModelInputs. It provides validation, scaling, serialization, and constraint management for optimization model inputs.
Key classes: - OptimizationModelInputs: Validated data structure for optimization inputs - ModelInputManager: Handles conversion, serialization, and constraint overrides
Classes¶
OptimizationModelInputs
¶
Bases: BaseModel
Interface data structure for linking LCA-based outputs with optimization inputs.
This class organizes all relevant inputs needed to build a temporal, process-based life cycle model suitable for linear optimization, including foreground and background exchanges, temporal system information, and optional process constraints.
Functions¶
check_all_keys(data)
¶
Validate that all dictionary keys reference valid set elements.
This validator ensures that all keys in the input dictionaries (e.g., demand, foreground_technosphere) reference elements that exist in the corresponding sets (e.g., PROCESS, PRODUCT, SYSTEM_TIME). This prevents runtime errors from invalid references.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
dict
|
The raw data dictionary before model instantiation. |
required |
Returns:
| Type | Description |
|---|---|
dict
|
The validated data dictionary. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If any dictionary key references an element not in the corresponding set. |
Source code in src/optimex/converter.py
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 | |
validate_constant_operation_flows() -> OptimizationModelInputs
¶
Validate that flows marked as operational are constant over process time.
For flexible operation mode, flows that occur during the operation phase must have constant values across process time steps. This is because the optimization scales these flows linearly with the operation variable. Time-varying operational flows would require fixed operation mode instead.
Returns:
| Type | Description |
|---|---|
OptimizationModelInputs
|
Self, after validation. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If any operational flow has varying values across process time. |
Source code in src/optimex/converter.py
validate_process_limits_consistency() -> OptimizationModelInputs
¶
Validate that min limits are not greater than max limits for process bounds.
This ensures logical consistency of the bounds - having min > max would create an infeasible constraint.
Source code in src/optimex/converter.py
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 | |
warn_negative_tau_boundary() -> OptimizationModelInputs
¶
Warn about negative process times that may fall outside SYSTEM_TIME.
When tau < 0 (e.g., construction before deployment), the contribution appears at system time (t - tau). If min(SYSTEM_TIME) - tau < min(SYSTEM_TIME), those contributions are lost for early installations.
Example: With SYSTEM_TIME starting at 2020 and tau=-1: - Installation at 2020 has construction at t=2019 (NOT in SYSTEM_TIME) - These emissions are silently ignored
This validator warns users about this boundary condition.
Source code in src/optimex/converter.py
get_scaled_copy() -> Tuple[OptimizationModelInputs, Dict[str, Any]]
¶
Create a scaled copy of inputs for numerical stability in optimization.
Scaling improves solver performance by normalizing values to similar magnitudes. The method scales foreground tensors, characterization factors, demand, and limits while preserving the original data structure. Scaling factors are returned for denormalizing results.
If vintage-aware tensors are provided, they are expanded to effective 4D tensors for use by the optimizer.
Returns:
| Type | Description |
|---|---|
tuple[OptimizationModelInputs, dict]
|
|
Source code in src/optimex/converter.py
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 | |
ModelInputManager()
¶
Interface between LCA data processing and optimization modeling.
The ModelInputManager is responsible for transforming, validating, and managing
structured data inputs for optimization models derived from an LCADataProcessor.
Responsibilities:
- Extracts raw structural and quantitative data from an
LCADataProcessorinstance. - Constructs and validates a
OptimizationModelInputsPydantic model, ensuring all necessary fields are populated and internally consistent. - Allows for user-defined overrides of any input fields to enable customization, correction, or scenario-specific tuning.
- Supports serialization and deserialization of
OptimizationModelInputsfor reproducibility, sharing, or caching via.jsonor.pickle. - Provides access to scaled versions of the model inputs (e.g., for numerical stability in optimization solvers), with metadata on scaling transformations.
This class is intended to serve as the main interface between upstream life cycle assessment (LCA) data and downstream optimization workflows, abstracting away validation, preprocessing, and I/O concerns from both ends.
Example
Initialize¶
manager = ModelInputManager()
Parse data from LCA data processor¶
inputs = manager.parse_from_lca_processor(lca_data_processor)
Optionally override fields¶
inputs = manager.override_inputs(PROCESS=["P1", "P2"], demand={...})
Save to disk¶
manager.save("inputs.json")
Load from disk¶
manager.load("inputs.json")
Get a numerically scaled version¶
scaled_inputs, scale_factors = inputs.get_scaled_copy()
Initialize a new ModelInputManager with empty model inputs.
The manager starts with no model inputs. Use parse_from_lca_processor()
to populate inputs from an LCADataProcessor, or use load() to load
previously saved inputs from disk.
Source code in src/optimex/converter.py
Functions¶
parse_from_lca_processor(lca_processor: LCADataProcessor) -> OptimizationModelInputs
¶
Extracts data from the LCADataProcessor and constructs OptimizationModelInputs.
Source code in src/optimex/converter.py
override(**overrides) -> OptimizationModelInputs
¶
Override fields of the current OptimizationModelInputs instance and re-validate.
Parameters: overrides: Keyword arguments matching OptimizationModelInputs fields to override.
Source code in src/optimex/converter.py
extend_demand(years: int) -> OptimizationModelInputs
¶
Extend demand beyond the current horizon by repeating last known values.
This addresses the "end-of-horizon" effect where the optimizer doesn't build capacity near the end because there's no future demand. By extending demand, the model accounts for ongoing production requirements.
Also extends all time-indexed tensors (foreground_technosphere, foreground_biosphere, background_inventory, characterization) by copying the last year's values to the extended years.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
years
|
int
|
Number of additional years to extend beyond current SYSTEM_TIME. |
required |
Returns:
| Type | Description |
|---|---|
OptimizationModelInputs
|
Updated model inputs with extended time horizon and demand. |
Source code in src/optimex/converter.py
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 | |
save_inputs(path: str) -> None
¶
Save the current OptimizationModelInputs to a JSON or pickle file.
Use this to save model inputs so you can recreate the optimization model without re-running LCA processing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str
|
File path with .json or .pkl extension. - .json: Human-readable, good for inspection and version control - .pkl: Faster, preserves exact Python types |
required |
Examples:
>>> manager.save_inputs("model_inputs.json")
>>> # Later:
>>> manager.load_inputs("model_inputs.json")
>>> model = optimizer.create_model(manager.model_inputs, ...)
Source code in src/optimex/converter.py
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 | |
load_inputs(path: str) -> OptimizationModelInputs
¶
Load OptimizationModelInputs from a JSON or pickle file.
Use this to load previously saved model inputs, allowing you to recreate the optimization model without re-running LCA processing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str
|
File path with .json or .pkl extension. |
required |
Returns:
| Type | Description |
|---|---|
OptimizationModelInputs
|
The loaded model inputs, also stored in self.model_inputs. |
Examples:
>>> manager = ModelInputManager()
>>> manager.load_inputs("model_inputs.json")
>>> model = optimizer.create_model(manager.model_inputs, ...)
Source code in src/optimex/converter.py
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 | |
Functions¶
construct_vintage_mapping(reference_vintages: List[int], system_times: List[int]) -> Dict[Tuple[int, int], float]
¶
Construct a linear interpolation-based mapping matrix between installation years and reference vintages.
For each year in system_times (potential installation years), this function computes interpolation weights for each reference vintage. The result maps (reference_vintage, installation_year) tuples to interpolation weights.
The weights sum to 1 for each installation year and are linearly interpolated between the closest two reference vintages. If the installation year is outside the range of reference vintages, all weight is assigned to the nearest boundary vintage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reference_vintages
|
List[int]
|
List of reference vintage years where parameters are explicitly defined. |
required |
system_times
|
List[int]
|
List of system time points (potential installation years). |
required |
Returns:
| Type | Description |
|---|---|
Dict[Tuple[int, int], float]
|
Mapping from (reference_vintage, installation_year) to interpolation weight. Only non-zero weights are included. |
Examples:
>>> mapping = construct_vintage_mapping([2020, 2030], [2020, 2025, 2030])
>>> mapping[(2020, 2020)] # 100% weight to 2020 vintage for 2020 installation
1.0
>>> mapping[(2020, 2025)] # 50% weight to 2020 vintage for 2025 installation
0.5
>>> mapping[(2030, 2025)] # 50% weight to 2030 vintage for 2025 installation
0.5
Source code in src/optimex/converter.py
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 | |
expand_foreground_tensor_with_vintages(vintage_tensor: Dict[Tuple[str, str, int, int], float], reference_vintages: List[int], system_times: List[int]) -> Dict[Tuple[str, str, int, int], float]
¶
Expand a vintage-specific foreground tensor to all system time installation years.
Takes a tensor defined at reference vintage years and interpolates values for all system time points (potential installation years).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
vintage_tensor
|
Dict[Tuple[str, str, int, int], float]
|
Input tensor mapping (process, flow, process_time, vintage_year) to value. Only defined at reference vintages. |
required |
reference_vintages
|
List[int]
|
List of reference vintage years. |
required |
system_times
|
List[int]
|
List of system time points to expand to. |
required |
Returns:
| Type | Description |
|---|---|
Dict[Tuple[str, str, int, int], float]
|
Expanded tensor with values for all system time installation years. |
Examples:
>>> vintage_tensor = {
... ("EV", "electricity", 1, 2020): 60,
... ("EV", "electricity", 1, 2030): 40,
... }
>>> expanded = expand_foreground_tensor_with_vintages(
... vintage_tensor, [2020, 2030], [2020, 2025, 2030]
... )
>>> expanded[("EV", "electricity", 1, 2025)] # Interpolated value
50.0
Source code in src/optimex/converter.py
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 | |
expand_foreground_tensor_with_evolution(base_tensor: Dict[Tuple[str, str, int], float], vintage_improvements: Dict[Tuple[str, str, int], float], reference_vintages: List[int], system_times: List[int], flow_type: str) -> Dict[Tuple[str, str, int, int], float]
¶
Expand a base foreground tensor using technology evolution scaling factors.
Takes a base 3D tensor and applies vintage-specific scaling factors to produce a 4D tensor with installation year dimension. ONLY expands (process, flow) pairs that have entries in vintage_improvements - other pairs are left unchanged to use the efficient 3D path in the optimizer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
base_tensor
|
Dict[Tuple[str, str, int], float]
|
Base tensor mapping (process, flow, process_time) to value. |
required |
vintage_improvements
|
Dict[Tuple[str, str, int], float]
|
Scaling factors mapping (process, flow, vintage_year) to multiplier. |
required |
reference_vintages
|
List[int]
|
List of reference vintage years. |
required |
system_times
|
List[int]
|
List of system time points to expand to. |
required |
flow_type
|
str
|
Type of flow for filtering (e.g., "INTERMEDIATE_FLOW", "ELEMENTARY_FLOW"). |
required |
Returns:
| Type | Description |
|---|---|
Dict[Tuple[str, str, int, int], float]
|
Expanded tensor with values for all system time installation years. Only contains entries for (process, flow) pairs with evolution factors. |
Examples:
>>> base = {("EV", "electricity", 1): 60}
>>> evolution = {
... ("EV", "electricity", 2020): 1.0,
... ("EV", "electricity", 2030): 0.667,
... }
>>> expanded = expand_foreground_tensor_with_evolution(
... base, evolution, [2020, 2030], [2020, 2025, 2030], "INTERMEDIATE_FLOW"
... )
>>> expanded[("EV", "electricity", 1, 2020)] # base * 1.0
60.0
>>> expanded[("EV", "electricity", 1, 2030)] # base * 0.667
40.02
Source code in src/optimex/converter.py
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 | |