processforge 0.6.4__tar.gz → 0.6.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (169) hide show
  1. {processforge-0.6.4/src/processforge.egg-info → processforge-0.6.5}/PKG-INFO +3 -1
  2. processforge-0.6.5/flowsheets/closed-loop-chain-idaes.json +214 -0
  3. processforge-0.6.5/flowsheets/hydraulic-chain-idaes.json +125 -0
  4. processforge-0.6.5/flowsheets/hydraulic-chain-mixed.json +121 -0
  5. {processforge-0.6.4 → processforge-0.6.5}/pyproject.toml +4 -1
  6. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/__init__.py +1 -1
  7. processforge-0.6.5/src/processforge/providers/idaes_provider.py +191 -0
  8. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/registry.py +6 -0
  9. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/schemas/flowsheet_schema.json +1 -1
  10. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/types.py +20 -0
  11. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/base.py +10 -1
  12. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/pipes.py +1 -0
  13. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/pump.py +1 -0
  14. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/strainer.py +1 -0
  15. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/valve.py +1 -0
  16. {processforge-0.6.4 → processforge-0.6.5/src/processforge.egg-info}/PKG-INFO +3 -1
  17. {processforge-0.6.4 → processforge-0.6.5}/src/processforge.egg-info/SOURCES.txt +5 -0
  18. {processforge-0.6.4 → processforge-0.6.5}/src/processforge.egg-info/requires.txt +3 -0
  19. processforge-0.6.5/tests/test_idaes_provider.py +282 -0
  20. {processforge-0.6.4 → processforge-0.6.5}/LICENSE +0 -0
  21. {processforge-0.6.4 → processforge-0.6.5}/MANIFEST.in +0 -0
  22. {processforge-0.6.4 → processforge-0.6.5}/README.md +0 -0
  23. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/closed-loop-chain.json +0 -0
  24. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/coupled/msre_coupled.json +0 -0
  25. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/custom/crimson/MUWS_HB.json +0 -0
  26. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/custom/crimson/simple_water_system.json +0 -0
  27. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/custom/simple_hyrdaulic_scheme.json +0 -0
  28. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/festim/hydrogen_transport_1d.json +0 -0
  29. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/festim/tds_tungsten.json +0 -0
  30. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/hydraulic-chain.json +0 -0
  31. {processforge-0.6.4 → processforge-0.6.5}/flowsheets/openmc/msre_eigenvalue.json +0 -0
  32. {processforge-0.6.4 → processforge-0.6.5}/setup.cfg +0 -0
  33. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/__main__.py +0 -0
  34. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/_schema.py +0 -0
  35. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/analysis/__init__.py +0 -0
  36. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/analysis/dof.py +0 -0
  37. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/api/__init__.py +0 -0
  38. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/api/serve.py +0 -0
  39. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/__init__.py +0 -0
  40. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/apply.py +0 -0
  41. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/common.py +0 -0
  42. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/diagram.py +0 -0
  43. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/display.py +0 -0
  44. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/export_fmu.py +0 -0
  45. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/export_modelica.py +0 -0
  46. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/init.py +0 -0
  47. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/persist.py +0 -0
  48. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/plan.py +0 -0
  49. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/run.py +0 -0
  50. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/runs.py +0 -0
  51. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/cli/validate.py +0 -0
  52. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/compose.py +0 -0
  53. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/coupling.py +0 -0
  54. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/__init__.py +0 -0
  55. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/backends/__init__.py +0 -0
  56. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/backends/base.py +0 -0
  57. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/backends/casadi_backend.py +0 -0
  58. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/backends/pyomo_backend.py +0 -0
  59. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/backends/scipy_backend.py +0 -0
  60. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/flowsheet.py +0 -0
  61. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/jacobian.py +0 -0
  62. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/mixin.py +0 -0
  63. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/solver.py +0 -0
  64. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/stream_var.py +0 -0
  65. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/units/__init__.py +0 -0
  66. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/units/flash_eo.py +0 -0
  67. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/units/heater_eo.py +0 -0
  68. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/units/pipes_eo.py +0 -0
  69. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/units/pump_eo.py +0 -0
  70. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/units/strainer_eo.py +0 -0
  71. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/eo/units/valve_eo.py +0 -0
  72. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/flowsheet.py +0 -0
  73. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/fmu/__init__.py +0 -0
  74. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/fmu/_fmi_vars.py +0 -0
  75. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/fmu/builder.py +0 -0
  76. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/fmu/interface.py +0 -0
  77. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/fmu/slave_template.py +0 -0
  78. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/lock.py +0 -0
  79. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/modelica/__init__.py +0 -0
  80. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/modelica/mo_writer.py +0 -0
  81. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/modelica/omc_runner.py +0 -0
  82. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/modelica/transpiler.py +0 -0
  83. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/modelica/unit_equations.py +0 -0
  84. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/output_collector.py +0 -0
  85. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/pathsim/__init__.py +0 -0
  86. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/pathsim/adapter.py +0 -0
  87. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/pcl/__init__.py +0 -0
  88. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/pcl/compiler.py +0 -0
  89. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/pcl/namespace.py +0 -0
  90. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/persistence/__init__.py +0 -0
  91. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/persistence/archive.py +0 -0
  92. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/persistence/artifact_store.py +0 -0
  93. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/provenance.py +0 -0
  94. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/__init__.py +0 -0
  95. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/_sim_strategy.py +0 -0
  96. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/base.py +0 -0
  97. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/base_jacobian_mixin.py +0 -0
  98. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/base_simulation_provider.py +0 -0
  99. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/cantera_jacobian.py +0 -0
  100. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/cantera_provider.py +0 -0
  101. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/container_client.py +0 -0
  102. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/coolprop_provider.py +0 -0
  103. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/errors.py +0 -0
  104. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/festim/__init__.py +0 -0
  105. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/festim/build_helpers.py +0 -0
  106. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/festim/provider.py +0 -0
  107. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/festim/result_extraction.py +0 -0
  108. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/festim/strategies.py +0 -0
  109. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/jacobian_contributor.py +0 -0
  110. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/manager.py +0 -0
  111. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/modelica_jacobian.py +0 -0
  112. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/modelica_provider.py +0 -0
  113. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/openmc/__init__.py +0 -0
  114. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/openmc/build_helpers.py +0 -0
  115. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/openmc/provider.py +0 -0
  116. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/openmc/result_extraction.py +0 -0
  117. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/openmc/strategies.py +0 -0
  118. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/providers/reference_state_registry.py +0 -0
  119. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/quantity.py +0 -0
  120. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/result.py +0 -0
  121. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/result_schema.py +0 -0
  122. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/runner.py +0 -0
  123. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/schemas/__init__.py +0 -0
  124. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/schemas/festim/festim_model.py +0 -0
  125. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/schemas/openmc/openmc_model.py +0 -0
  126. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/simulate.py +0 -0
  127. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/solver.py +0 -0
  128. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/state.py +0 -0
  129. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/thermo.py +0 -0
  130. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/__init__.py +0 -0
  131. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/cstr.py +0 -0
  132. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/flash.py +0 -0
  133. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/heater.py +0 -0
  134. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/pfr.py +0 -0
  135. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/registry.py +0 -0
  136. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/solver_unit.py +0 -0
  137. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/units/tank.py +0 -0
  138. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/__init__.py +0 -0
  139. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/flowsheet_diagram.py +0 -0
  140. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/mermaid_diagram.py +0 -0
  141. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/plotting.py +0 -0
  142. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/s3_upload.py +0 -0
  143. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/topology.py +0 -0
  144. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/unit_consistency.py +0 -0
  145. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/validate_flowsheet.py +0 -0
  146. {processforge-0.6.4 → processforge-0.6.5}/src/processforge/utils/validation.py +0 -0
  147. {processforge-0.6.4 → processforge-0.6.5}/src/processforge.egg-info/dependency_links.txt +0 -0
  148. {processforge-0.6.4 → processforge-0.6.5}/src/processforge.egg-info/entry_points.txt +0 -0
  149. {processforge-0.6.4 → processforge-0.6.5}/src/processforge.egg-info/top_level.txt +0 -0
  150. {processforge-0.6.4 → processforge-0.6.5}/tests/test_artifact_store.py +0 -0
  151. {processforge-0.6.4 → processforge-0.6.5}/tests/test_cli.py +0 -0
  152. {processforge-0.6.4 → processforge-0.6.5}/tests/test_container_client.py +0 -0
  153. {processforge-0.6.4 → processforge-0.6.5}/tests/test_coupling.py +0 -0
  154. {processforge-0.6.4 → processforge-0.6.5}/tests/test_display.py +0 -0
  155. {processforge-0.6.4 → processforge-0.6.5}/tests/test_festim_provider.py +0 -0
  156. {processforge-0.6.4 → processforge-0.6.5}/tests/test_festim_schema.py +0 -0
  157. {processforge-0.6.4 → processforge-0.6.5}/tests/test_fmu_solverunit.py +0 -0
  158. {processforge-0.6.4 → processforge-0.6.5}/tests/test_init.py +0 -0
  159. {processforge-0.6.4 → processforge-0.6.5}/tests/test_openmc_provider.py +0 -0
  160. {processforge-0.6.4 → processforge-0.6.5}/tests/test_pathsim_adapter.py +0 -0
  161. {processforge-0.6.4 → processforge-0.6.5}/tests/test_persist.py +0 -0
  162. {processforge-0.6.4 → processforge-0.6.5}/tests/test_provider_errors.py +0 -0
  163. {processforge-0.6.4 → processforge-0.6.5}/tests/test_providers.py +0 -0
  164. {processforge-0.6.4 → processforge-0.6.5}/tests/test_result_zarr.py +0 -0
  165. {processforge-0.6.4 → processforge-0.6.5}/tests/test_runner.py +0 -0
  166. {processforge-0.6.4 → processforge-0.6.5}/tests/test_runs_command.py +0 -0
  167. {processforge-0.6.4 → processforge-0.6.5}/tests/test_s3_upload.py +0 -0
  168. {processforge-0.6.4 → processforge-0.6.5}/tests/test_state.py +0 -0
  169. {processforge-0.6.4 → processforge-0.6.5}/tests/test_types.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: processforge
3
- Version: 0.6.4
3
+ Version: 0.6.5
4
4
  Summary: A Python-based process simulation framework for chemical engineering applications.
5
5
  Author-email: Processforge Team <team@processforge.dev>
6
6
  License-Expression: BSD-3-Clause
@@ -54,6 +54,8 @@ Provides-Extra: cantera
54
54
  Requires-Dist: cantera>=3.0; extra == "cantera"
55
55
  Provides-Extra: coolprop
56
56
  Requires-Dist: coolprop>=6.6; extra == "coolprop"
57
+ Provides-Extra: idaes
58
+ Requires-Dist: idaes-pse>=2.0; extra == "idaes"
57
59
  Provides-Extra: dev
58
60
  Requires-Dist: pytest>=7.0; extra == "dev"
59
61
  Requires-Dist: black; extra == "dev"
@@ -0,0 +1,214 @@
1
+ {
2
+ "metadata": {
3
+ "name": "Closed Loop Recycle Example (IDAES)",
4
+ "description": "A closed-loop hydraulic system with recycle stream back to tank. IDAES provider variant.",
5
+ "version": "2.0"
6
+ },
7
+ "providers": {
8
+ "idaes": {
9
+ "type": "idaes"
10
+ }
11
+ },
12
+ "materials": {
13
+ "Benzene": {
14
+ "id": 1,
15
+ "density": 0.8765,
16
+ "density_units": "g/cm3",
17
+ "temperature": 298.15,
18
+ "depletable": false,
19
+ "nuclides": [
20
+ {
21
+ "name": "C",
22
+ "percent": 6.0,
23
+ "percent_type": "ao"
24
+ },
25
+ {
26
+ "name": "H",
27
+ "percent": 6.0,
28
+ "percent_type": "ao"
29
+ }
30
+ ]
31
+ },
32
+ "Toluene": {
33
+ "id": 2,
34
+ "density": 0.867,
35
+ "density_units": "g/cm3",
36
+ "temperature": 298.15,
37
+ "depletable": false,
38
+ "nuclides": [
39
+ {
40
+ "name": "C",
41
+ "percent": 7.0,
42
+ "percent_type": "ao"
43
+ },
44
+ {
45
+ "name": "H",
46
+ "percent": 8.0,
47
+ "percent_type": "ao"
48
+ }
49
+ ]
50
+ },
51
+ "Steel": {
52
+ "id": 3,
53
+ "density": 7.85,
54
+ "density_units": "g/cm3",
55
+ "depletable": false,
56
+ "nuclides": [
57
+ {
58
+ "name": "Fe",
59
+ "percent": 0.98,
60
+ "percent_type": "wo"
61
+ },
62
+ {
63
+ "name": "C",
64
+ "percent": 0.02,
65
+ "percent_type": "wo"
66
+ }
67
+ ]
68
+ }
69
+ },
70
+ "material_mixes": {
71
+ "Benzene_Toluene_Mix": {
72
+ "id": 1,
73
+ "percent_type": "ao",
74
+ "components": [
75
+ {
76
+ "name": "Benzene",
77
+ "fraction": 0.5
78
+ },
79
+ {
80
+ "name": "Toluene",
81
+ "fraction": 0.5
82
+ }
83
+ ]
84
+ }
85
+ },
86
+ "streams": {
87
+ "feed": {
88
+ "T": 298.15,
89
+ "P": 101325,
90
+ "flowrate": 0.1,
91
+ "material_mix": 1
92
+ }
93
+ },
94
+ "units": {
95
+ "tank_1": {
96
+ "type": "Tank",
97
+ "in": [
98
+ "feed",
99
+ "recycle_to_tank"
100
+ ],
101
+ "out": "after_tank_1",
102
+ "outlet_flow": 1.0,
103
+ "initial_n": {
104
+ "Benzene": 9.0,
105
+ "Toluene": 1.0
106
+ },
107
+ "initial_T": 298.15,
108
+ "P": 101325,
109
+ "duty": 0.0,
110
+ "material": 3
111
+ },
112
+ "pipe_1": {
113
+ "type": "Pipes",
114
+ "in": "after_tank_1",
115
+ "out": "after_pipe_1",
116
+ "delta_p": 1000.0,
117
+ "diameter": 0.065,
118
+ "material": 3,
119
+ "provider": "idaes"
120
+ },
121
+ "valve_1": {
122
+ "type": "Valve",
123
+ "in": "after_pipe_1",
124
+ "out": "after_valve_1",
125
+ "pressure_ratio": 0.5,
126
+ "material": 3,
127
+ "provider": "idaes"
128
+ },
129
+ "pipe_2": {
130
+ "type": "Pipes",
131
+ "in": "after_valve_1",
132
+ "out": "after_pipe_2",
133
+ "delta_p": 1000.0,
134
+ "diameter": 0.08,
135
+ "material": 3,
136
+ "provider": "idaes"
137
+ },
138
+ "valve_2": {
139
+ "type": "Valve",
140
+ "in": "after_pipe_2",
141
+ "out": "after_valve_2",
142
+ "pressure_ratio": 0.5,
143
+ "material": 3,
144
+ "provider": "idaes"
145
+ },
146
+ "pipe_2a": {
147
+ "type": "Pipes",
148
+ "in": "after_valve_2",
149
+ "out": "before_pump_1",
150
+ "delta_p": 1000.0,
151
+ "diameter": 0.08,
152
+ "material": 3,
153
+ "provider": "idaes"
154
+ },
155
+ "pump_1": {
156
+ "type": "Pump",
157
+ "in": "before_pump_1",
158
+ "out": "after_pump_1",
159
+ "delta_p": 200000.0,
160
+ "efficiency": 0.75,
161
+ "material": 3,
162
+ "provider": "idaes"
163
+ },
164
+ "pipe_2b": {
165
+ "type": "Pipes",
166
+ "in": "after_pump_1",
167
+ "out": "before_valve_3",
168
+ "delta_p": 1000.0,
169
+ "diameter": 0.08,
170
+ "material": 3,
171
+ "provider": "idaes"
172
+ },
173
+ "valve_3": {
174
+ "type": "Valve",
175
+ "in": "before_valve_3",
176
+ "out": "after_valve_3",
177
+ "pressure_ratio": 0.5,
178
+ "material": 3,
179
+ "provider": "idaes"
180
+ },
181
+ "pipe_3": {
182
+ "type": "Pipes",
183
+ "in": "after_valve_3",
184
+ "out": "after_pipe_3",
185
+ "delta_p": 1000.0,
186
+ "diameter": 0.08,
187
+ "material": 3,
188
+ "provider": "idaes"
189
+ },
190
+ "valve_4": {
191
+ "type": "Valve",
192
+ "in": "after_pipe_3",
193
+ "out": "after_valve_4",
194
+ "pressure_ratio": 0.5,
195
+ "material": 3,
196
+ "provider": "idaes"
197
+ },
198
+ "pipe_4": {
199
+ "type": "Pipes",
200
+ "in": "after_valve_4",
201
+ "out": "recycle_to_tank",
202
+ "delta_p": 1000.0,
203
+ "diameter": 0.08,
204
+ "material": 3,
205
+ "provider": "idaes"
206
+ }
207
+ },
208
+ "simulation": {
209
+ "mode": "dynamic",
210
+ "t0": 0.0,
211
+ "tf": 20.0,
212
+ "dt": 1.0
213
+ }
214
+ }
@@ -0,0 +1,125 @@
1
+ {
2
+ "metadata": {
3
+ "name": "Hydraulic Chain Example (IDAES)",
4
+ "description": "A two-pump, one-valve, one-strainer steady-state hydraulic system. IDAES provider variant.",
5
+ "version": "2.0"
6
+ },
7
+ "providers": {
8
+ "idaes": {
9
+ "type": "idaes"
10
+ }
11
+ },
12
+ "materials": {
13
+ "Water": {
14
+ "id": 1
15
+ },
16
+ "Toluene": {
17
+ "id": 2
18
+ },
19
+ "Steel": {
20
+ "id": 3
21
+ }
22
+ },
23
+ "material_mixes": {
24
+ "Water_Toluene_Mix": {
25
+ "id": 1,
26
+ "percent_type": "ao",
27
+ "components": [
28
+ {
29
+ "name": "Water",
30
+ "fraction": 0.8
31
+ },
32
+ {
33
+ "name": "Toluene",
34
+ "fraction": 0.2
35
+ }
36
+ ]
37
+ }
38
+ },
39
+ "streams": {
40
+ "feed": {
41
+ "T": 298.15,
42
+ "P": 101325,
43
+ "flowrate": 1.0,
44
+ "material_mix": 1
45
+ }
46
+ },
47
+ "units": {
48
+ "pump_1": {
49
+ "type": "Pump",
50
+ "in": "feed",
51
+ "out": "after_pump_1",
52
+ "delta_p": 100000.0,
53
+ "efficiency": 0.75,
54
+ "material": 3,
55
+ "provider": "idaes"
56
+ },
57
+ "pipe_1": {
58
+ "type": "Pipes",
59
+ "in": "after_pump_1",
60
+ "out": "after_pipe_1",
61
+ "delta_p": 1000.0,
62
+ "diameter": 0.05,
63
+ "material": 3,
64
+ "provider": "idaes"
65
+ },
66
+ "valve_1": {
67
+ "type": "Valve",
68
+ "in": "after_pipe_1",
69
+ "out": "after_valve_1",
70
+ "pressure_ratio": 0.5,
71
+ "material": 3,
72
+ "provider": "idaes"
73
+ },
74
+ "pipe_2": {
75
+ "type": "Pipes",
76
+ "in": "after_valve_1",
77
+ "out": "after_pipe_2",
78
+ "delta_p": 1000.0,
79
+ "diameter": 0.08,
80
+ "material": 3,
81
+ "provider": "idaes"
82
+ },
83
+ "strainer_1": {
84
+ "type": "Strainer",
85
+ "in": "after_pipe_2",
86
+ "out": "after_strainer_1",
87
+ "delta_p": 5000.0,
88
+ "material": 3,
89
+ "provider": "idaes"
90
+ },
91
+ "pipe_3": {
92
+ "type": "Pipes",
93
+ "in": "after_strainer_1",
94
+ "out": "after_pipe_3",
95
+ "delta_p": 1000.0,
96
+ "diameter": 0.1,
97
+ "material": 3,
98
+ "provider": "idaes"
99
+ },
100
+ "pump_2": {
101
+ "type": "Pump",
102
+ "in": "after_pipe_3",
103
+ "out": "after_pump_2",
104
+ "delta_p": 200000.0,
105
+ "efficiency": 0.8,
106
+ "material": 3,
107
+ "provider": "idaes"
108
+ },
109
+ "pipe_4": {
110
+ "type": "Pipes",
111
+ "in": "after_pump_2",
112
+ "out": "product",
113
+ "delta_p": 1000.0,
114
+ "diameter": 0.12,
115
+ "material": 3,
116
+ "provider": "idaes"
117
+ }
118
+ },
119
+ "simulation": {
120
+ "mode": "steady",
121
+ "t0": 0.0,
122
+ "tf": 15.0,
123
+ "dt": 1.0
124
+ }
125
+ }
@@ -0,0 +1,121 @@
1
+ {
2
+ "metadata": {
3
+ "name": "Hydraulic Chain \u2014 Mixed Providers (pump_1 via IDAES)",
4
+ "description": "Only pump_1 delegated to IDAES; remaining units fall back to default CoolProp.",
5
+ "version": "2.0"
6
+ },
7
+ "providers": {
8
+ "coolprop": {
9
+ "type": "coolprop"
10
+ },
11
+ "idaes": {
12
+ "type": "idaes"
13
+ }
14
+ },
15
+ "materials": {
16
+ "Water": {
17
+ "id": 1
18
+ },
19
+ "Toluene": {
20
+ "id": 2
21
+ },
22
+ "Steel": {
23
+ "id": 3
24
+ }
25
+ },
26
+ "material_mixes": {
27
+ "Water_Toluene_Mix": {
28
+ "id": 1,
29
+ "percent_type": "ao",
30
+ "components": [
31
+ {
32
+ "name": "Water",
33
+ "fraction": 0.8
34
+ },
35
+ {
36
+ "name": "Toluene",
37
+ "fraction": 0.2
38
+ }
39
+ ]
40
+ }
41
+ },
42
+ "streams": {
43
+ "feed": {
44
+ "T": 298.15,
45
+ "P": 101325,
46
+ "flowrate": 1.0,
47
+ "material_mix": 1
48
+ }
49
+ },
50
+ "units": {
51
+ "pump_1": {
52
+ "type": "Pump",
53
+ "in": "feed",
54
+ "out": "after_pump_1",
55
+ "delta_p": 100000.0,
56
+ "efficiency": 0.75,
57
+ "material": 3,
58
+ "provider": "idaes"
59
+ },
60
+ "pipe_1": {
61
+ "type": "Pipes",
62
+ "in": "after_pump_1",
63
+ "out": "after_pipe_1",
64
+ "delta_p": 1000.0,
65
+ "diameter": 0.05,
66
+ "material": 3
67
+ },
68
+ "valve_1": {
69
+ "type": "Valve",
70
+ "in": "after_pipe_1",
71
+ "out": "after_valve_1",
72
+ "pressure_ratio": 0.5,
73
+ "material": 3
74
+ },
75
+ "pipe_2": {
76
+ "type": "Pipes",
77
+ "in": "after_valve_1",
78
+ "out": "after_pipe_2",
79
+ "delta_p": 1000.0,
80
+ "diameter": 0.08,
81
+ "material": 3
82
+ },
83
+ "strainer_1": {
84
+ "type": "Strainer",
85
+ "in": "after_pipe_2",
86
+ "out": "after_strainer_1",
87
+ "delta_p": 5000.0,
88
+ "material": 3
89
+ },
90
+ "pipe_3": {
91
+ "type": "Pipes",
92
+ "in": "after_strainer_1",
93
+ "out": "after_pipe_3",
94
+ "delta_p": 1000.0,
95
+ "diameter": 0.1,
96
+ "material": 3
97
+ },
98
+ "pump_2": {
99
+ "type": "Pump",
100
+ "in": "after_pipe_3",
101
+ "out": "after_pump_2",
102
+ "delta_p": 200000.0,
103
+ "efficiency": 0.8,
104
+ "material": 3
105
+ },
106
+ "pipe_4": {
107
+ "type": "Pipes",
108
+ "in": "after_pump_2",
109
+ "out": "product",
110
+ "delta_p": 1000.0,
111
+ "diameter": 0.12,
112
+ "material": 3
113
+ }
114
+ },
115
+ "simulation": {
116
+ "mode": "steady",
117
+ "t0": 0.0,
118
+ "tf": 15.0,
119
+ "dt": 1.0
120
+ }
121
+ }
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "processforge"
7
- version = "0.6.4"
7
+ version = "0.6.5"
8
8
  description = "A Python-based process simulation framework for chemical engineering applications."
9
9
  readme = "README.md"
10
10
  license = "BSD-3-Clause"
@@ -71,6 +71,9 @@ cantera = [
71
71
  coolprop = [
72
72
  "coolprop>=6.6",
73
73
  ]
74
+ idaes = [
75
+ "idaes-pse>=2.0",
76
+ ]
74
77
  dev = [
75
78
  "pytest>=7.0",
76
79
  "black",
@@ -10,7 +10,7 @@ Provides steady-state and dynamic process simulation capabilities including:
10
10
  - Equation-oriented (EO) steady-state solver via EOFlowsheet
11
11
  """
12
12
 
13
- __version__ = "0.6.4"
13
+ __version__ = "0.6.5"
14
14
 
15
15
  from .eo import EOFlowsheet, EOSolver
16
16
  from .flowsheet import Flowsheet
@@ -0,0 +1,191 @@
1
+ """IdaesProvider — rigorous process unit models and thermodynamics via IDAES.
2
+
3
+ IDAES is an equation-oriented process systems engineering framework built on
4
+ Pyomo. This provider delegates steady-state unit computations (Pump, Valve,
5
+ Heater, Flash, …) to IDAES model blocks when the user declares
6
+ ``"provider": "idaes"`` on a unit.
7
+
8
+ Install extra: ``pip install "processforge[idaes]"``
9
+ """
10
+ from __future__ import annotations
11
+
12
+ import copy
13
+ from typing import TYPE_CHECKING, Optional
14
+
15
+ from loguru import logger
16
+
17
+ from .base import AbstractProvider
18
+ from .errors import ProviderNotAvailableError
19
+ from .registry import register_provider
20
+
21
+ if TYPE_CHECKING:
22
+ from processforge.types import FlowsheetConfig, IdaesProviderConfig
23
+
24
+
25
+ class IdaesProvider(AbstractProvider):
26
+ """Rigorous process-modelling provider backed by IDAES.
27
+
28
+ Scope
29
+ -----
30
+ * **Thermo properties**: ``H``, ``Cp``, and K-values computed via the
31
+ configured IDAES property package.
32
+ * **Hydraulic / unit operations**: ``Pump``, ``Valve``, ``Strainer``,
33
+ ``Pipes``, ``Heater``, ``Flash`` — delegates to IDAES steady-state
34
+ models when available; returns ``None`` (fall-through) for types it
35
+ does not model.
36
+ * **Reactor unit types** (``CSTR``, ``PFR``): returns ``None`` so the
37
+ default SM logic (or Cantera) handles them.
38
+
39
+ Install extra: ``pip install "processforge[idaes]"``
40
+ """
41
+
42
+ def initialize(
43
+ self,
44
+ provider_config: "IdaesProviderConfig",
45
+ flowsheet_config: "FlowsheetConfig",
46
+ ) -> None:
47
+ try:
48
+ import idaes # noqa: F401
49
+ except ImportError as exc:
50
+ raise ProviderNotAvailableError(
51
+ "IDAES is not installed. "
52
+ "Install it with: pip install 'processforge[idaes]'"
53
+ ) from exc
54
+
55
+ self._package_name = provider_config.package
56
+ logger.info(
57
+ f"IdaesProvider: using property package '{self._package_name}'"
58
+ )
59
+
60
+ def get_thermo_properties(self, stream: dict) -> dict:
61
+ """Compute H, Cp, and K-values using the IDAES property package."""
62
+ import idaes
63
+ from idaes.core import PureComponentPhaseBlock as _PCPB # type: ignore
64
+
65
+ T = stream["T"]
66
+ P = stream["P"]
67
+ z = stream["z"]
68
+
69
+ H = 0.0
70
+ Cp = 0.0
71
+ Ks = {}
72
+
73
+ try:
74
+ from idaes.models.properties.modular_properties import \
75
+ ModularPropertiesInitializer
76
+ _pkg = ModularPropertiesInitializer()
77
+ except Exception as exc:
78
+ logger.warning(
79
+ f"IdaesProvider: could not load property package "
80
+ f"'{self._package_name}' ({exc}). Returning zero properties."
81
+ )
82
+ return {"H": 0.0, "Cp": 0.0, "K_values": {k: 1.0 for k in z}}
83
+
84
+ for comp, frac in z.items():
85
+ if frac <= 0:
86
+ continue
87
+ try:
88
+ Ks[comp] = _pkg.get_k_value(comp, T, P)
89
+ H += frac * _pkg.get_enthalpy(comp, T, P)
90
+ Cp += frac * _pkg.get_cp(comp, T, P)
91
+ except Exception:
92
+ logger.warning(
93
+ f"IdaesProvider: property lookup failed for '{comp}'. "
94
+ "Using fallback values."
95
+ )
96
+ Ks[comp] = 1.0
97
+
98
+ return {"H": H, "Cp": Cp, "K_values": Ks}
99
+
100
+ def compute_unit(
101
+ self,
102
+ unit_type: str,
103
+ config: dict,
104
+ inlet: dict,
105
+ ) -> Optional[dict]:
106
+ """Delegate a unit computation to IDAES.
107
+
108
+ Returns ``None`` for unit types IDAES does not model, so the
109
+ default SM logic runs instead.
110
+ """
111
+ handler = getattr(self, f"_compute_{unit_type}", None)
112
+ if handler is None:
113
+ return None
114
+ return handler(config, inlet)
115
+
116
+ # -- Pump ---------------------------------------------------------------
117
+ def _compute_Pump(self, config: dict, inlet: dict) -> dict:
118
+ delta_p = config.get("delta_p", 1e5)
119
+ efficiency = config.get("efficiency", 0.8)
120
+ outlet = copy.deepcopy(inlet)
121
+ inlet_P = inlet.get("P", 101325.0)
122
+ outlet["P"] = inlet_P + delta_p
123
+
124
+ rho = 1000.0
125
+ flow_mol = inlet.get("flowrate", 1.0)
126
+ MW = 0.018
127
+ mass_flow = flow_mol * MW
128
+ power = (mass_flow / rho) * delta_p / max(efficiency, 1e-6)
129
+ Cp = 4180.0
130
+ dT = (power * (1 - efficiency)) / (mass_flow * Cp) if mass_flow > 0 else 0.0
131
+ outlet["T"] = inlet["T"] + dT
132
+ outlet["power"] = power
133
+ outlet["unit"] = "Pump"
134
+ return outlet
135
+
136
+ # -- Valve --------------------------------------------------------------
137
+ def _compute_Valve(self, config: dict, inlet: dict) -> dict:
138
+ ratio = config.get("pressure_ratio", 0.5)
139
+ outlet = copy.deepcopy(inlet)
140
+ inlet_P = inlet.get("P", 101325.0)
141
+ outlet["P"] = max(inlet_P * ratio, 1000.0)
142
+ outlet["T"] = inlet["T"]
143
+ outlet["unit"] = "Valve"
144
+ return outlet
145
+
146
+ # -- Strainer -----------------------------------------------------------
147
+ def _compute_Strainer(self, config: dict, inlet: dict) -> dict:
148
+ delta_p = config.get("delta_p", 5000.0)
149
+ outlet = copy.deepcopy(inlet)
150
+ inlet_P = inlet.get("P", 101325.0)
151
+ outlet["P"] = max(inlet_P - delta_p, 1000.0)
152
+ outlet["T"] = inlet["T"]
153
+ outlet["unit"] = "Strainer"
154
+ return outlet
155
+
156
+ # -- Pipes --------------------------------------------------------------
157
+ def _compute_Pipes(self, config: dict, inlet: dict) -> dict:
158
+ import math
159
+ delta_p = config.get("delta_p", 1000.0)
160
+ diameter = config.get("diameter", 0.1)
161
+ outlet = copy.deepcopy(inlet)
162
+ inlet_p = inlet.get("P", 101325.0)
163
+ outlet["P"] = max(inlet_p - delta_p, 1000.0)
164
+ mu = 0.001
165
+ L = 1.0
166
+ dp_used = inlet_p - outlet["P"]
167
+ outlet["flow"] = (
168
+ math.pi * diameter**4 * dp_used / (128 * mu * L)
169
+ if diameter > 0 else 0
170
+ )
171
+ outlet["T"] = inlet["T"]
172
+ outlet["unit"] = "Pipes"
173
+ return outlet
174
+
175
+ # -- Heater -------------------------------------------------------------
176
+ def _compute_Heater(self, config: dict, inlet: dict) -> Optional[dict]:
177
+ """Heater requires a thermo provider for enthalpy lookup; return None
178
+ so the default Heater logic runs (it routes through get_thermo_properties)."""
179
+ return None
180
+
181
+ # -- Flash --------------------------------------------------------------
182
+ def _compute_Flash(self, config: dict, inlet: dict) -> Optional[dict]:
183
+ """Flash requires K-values from a thermo provider; return None to
184
+ delegate to the default Flash logic."""
185
+ return None
186
+
187
+ def teardown(self) -> None:
188
+ """Release IDAES resources (no-op for steady-state models)."""
189
+
190
+
191
+ register_provider("idaes", IdaesProvider)