processforge 0.4.3__tar.gz → 0.5.0__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 (164) hide show
  1. {processforge-0.4.3/src/processforge.egg-info → processforge-0.5.0}/PKG-INFO +1 -1
  2. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/custom/crimson/simple_water_system.json +73 -82
  3. {processforge-0.4.3 → processforge-0.5.0}/pyproject.toml +1 -1
  4. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/__init__.py +1 -1
  5. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/common.py +3 -3
  6. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/__init__.py +20 -0
  7. processforge-0.5.0/src/processforge/providers/_sim_strategy.py +70 -0
  8. processforge-0.5.0/src/processforge/providers/base_simulation_provider.py +92 -0
  9. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/cantera_provider.py +2 -1
  10. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/container_client.py +2 -1
  11. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/coolprop_provider.py +4 -3
  12. processforge-0.5.0/src/processforge/providers/errors.py +453 -0
  13. processforge-0.5.0/src/processforge/providers/festim/__init__.py +16 -0
  14. processforge-0.5.0/src/processforge/providers/festim/build_helpers.py +349 -0
  15. processforge-0.5.0/src/processforge/providers/festim/provider.py +171 -0
  16. processforge-0.5.0/src/processforge/providers/festim/result_extraction.py +106 -0
  17. processforge-0.5.0/src/processforge/providers/festim/strategies.py +93 -0
  18. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/manager.py +45 -35
  19. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/modelica_provider.py +2 -1
  20. processforge-0.5.0/src/processforge/providers/openmc/__init__.py +16 -0
  21. processforge-0.5.0/src/processforge/providers/openmc/build_helpers.py +163 -0
  22. processforge-0.5.0/src/processforge/providers/openmc/provider.py +327 -0
  23. processforge-0.5.0/src/processforge/providers/openmc/result_extraction.py +194 -0
  24. processforge-0.5.0/src/processforge/providers/openmc/strategies.py +217 -0
  25. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/registry.py +83 -61
  26. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/schemas/festim/festim_model.py +1 -1
  27. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/utils/validate_flowsheet.py +3 -3
  28. {processforge-0.4.3 → processforge-0.5.0/src/processforge.egg-info}/PKG-INFO +1 -1
  29. {processforge-0.4.3 → processforge-0.5.0}/src/processforge.egg-info/SOURCES.txt +12 -2
  30. {processforge-0.4.3 → processforge-0.5.0}/tests/test_cli.py +9 -2
  31. {processforge-0.4.3 → processforge-0.5.0}/tests/test_coupling.py +1 -1
  32. {processforge-0.4.3 → processforge-0.5.0}/tests/test_festim_provider.py +35 -39
  33. {processforge-0.4.3 → processforge-0.5.0}/tests/test_init.py +6 -6
  34. {processforge-0.4.3 → processforge-0.5.0}/tests/test_openmc_provider.py +1 -1
  35. processforge-0.5.0/tests/test_provider_errors.py +216 -0
  36. {processforge-0.4.3 → processforge-0.5.0}/tests/test_providers.py +30 -3
  37. processforge-0.4.3/src/processforge/providers/errors.py +0 -276
  38. processforge-0.4.3/src/processforge/providers/festim_provider.py +0 -917
  39. processforge-0.4.3/src/processforge/providers/openmc_provider.py +0 -1066
  40. processforge-0.4.3/tests/test_provider_errors.py +0 -104
  41. {processforge-0.4.3 → processforge-0.5.0}/LICENSE +0 -0
  42. {processforge-0.4.3 → processforge-0.5.0}/MANIFEST.in +0 -0
  43. {processforge-0.4.3 → processforge-0.5.0}/README.md +0 -0
  44. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/closed-loop-chain.json +0 -0
  45. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/coupled/msre_coupled.json +0 -0
  46. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/custom/crimson/MUWS_HB.json +0 -0
  47. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/custom/simple_hyrdaulic_scheme.json +0 -0
  48. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/festim/hydrogen_transport_1d.json +0 -0
  49. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/festim/tds_tungsten.json +0 -0
  50. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/hydraulic-chain.json +0 -0
  51. {processforge-0.4.3 → processforge-0.5.0}/flowsheets/openmc/msre_eigenvalue.json +0 -0
  52. {processforge-0.4.3 → processforge-0.5.0}/setup.cfg +0 -0
  53. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/__main__.py +0 -0
  54. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/_schema.py +0 -0
  55. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/analysis/__init__.py +0 -0
  56. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/analysis/dof.py +0 -0
  57. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/api/__init__.py +0 -0
  58. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/api/serve.py +0 -0
  59. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/__init__.py +0 -0
  60. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/apply.py +0 -0
  61. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/diagram.py +0 -0
  62. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/display.py +0 -0
  63. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/export_fmu.py +0 -0
  64. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/export_modelica.py +0 -0
  65. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/init.py +0 -0
  66. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/persist.py +0 -0
  67. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/plan.py +0 -0
  68. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/run.py +0 -0
  69. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/runs.py +0 -0
  70. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/cli/validate.py +0 -0
  71. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/compose.py +0 -0
  72. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/coupling.py +0 -0
  73. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/__init__.py +0 -0
  74. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/backends/__init__.py +0 -0
  75. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/backends/base.py +0 -0
  76. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/backends/casadi_backend.py +0 -0
  77. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/backends/pyomo_backend.py +0 -0
  78. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/backends/scipy_backend.py +0 -0
  79. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/flowsheet.py +0 -0
  80. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/jacobian.py +0 -0
  81. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/mixin.py +0 -0
  82. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/solver.py +0 -0
  83. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/stream_var.py +0 -0
  84. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/units/__init__.py +0 -0
  85. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/units/flash_eo.py +0 -0
  86. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/units/heater_eo.py +0 -0
  87. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/units/pipes_eo.py +0 -0
  88. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/units/pump_eo.py +0 -0
  89. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/units/strainer_eo.py +0 -0
  90. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/eo/units/valve_eo.py +0 -0
  91. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/flowsheet.py +0 -0
  92. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/fmu/__init__.py +0 -0
  93. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/fmu/_fmi_vars.py +0 -0
  94. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/fmu/builder.py +0 -0
  95. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/fmu/interface.py +0 -0
  96. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/fmu/slave_template.py +0 -0
  97. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/lock.py +0 -0
  98. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/modelica/__init__.py +0 -0
  99. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/modelica/mo_writer.py +0 -0
  100. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/modelica/omc_runner.py +0 -0
  101. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/modelica/transpiler.py +0 -0
  102. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/modelica/unit_equations.py +0 -0
  103. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/output_collector.py +0 -0
  104. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/pathsim/__init__.py +0 -0
  105. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/pathsim/adapter.py +0 -0
  106. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/pcl/__init__.py +0 -0
  107. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/pcl/compiler.py +0 -0
  108. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/pcl/namespace.py +0 -0
  109. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/persistence/__init__.py +0 -0
  110. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/persistence/archive.py +0 -0
  111. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/persistence/artifact_store.py +0 -0
  112. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/provenance.py +0 -0
  113. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/base.py +0 -0
  114. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/base_jacobian_mixin.py +0 -0
  115. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/cantera_jacobian.py +0 -0
  116. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/jacobian_contributor.py +0 -0
  117. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/modelica_jacobian.py +0 -0
  118. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/providers/reference_state_registry.py +0 -0
  119. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/quantity.py +0 -0
  120. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/result.py +0 -0
  121. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/result_schema.py +0 -0
  122. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/schemas/__init__.py +0 -0
  123. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/schemas/flowsheet_schema.json +0 -0
  124. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/schemas/openmc/openmc_model.py +0 -0
  125. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/simulate.py +0 -0
  126. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/solver.py +0 -0
  127. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/state.py +0 -0
  128. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/thermo.py +0 -0
  129. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/types.py +0 -0
  130. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/__init__.py +0 -0
  131. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/base.py +0 -0
  132. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/cstr.py +0 -0
  133. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/flash.py +0 -0
  134. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/heater.py +0 -0
  135. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/pfr.py +0 -0
  136. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/pipes.py +0 -0
  137. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/pump.py +0 -0
  138. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/registry.py +0 -0
  139. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/solver_unit.py +0 -0
  140. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/strainer.py +0 -0
  141. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/tank.py +0 -0
  142. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/units/valve.py +0 -0
  143. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/utils/__init__.py +0 -0
  144. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/utils/flowsheet_diagram.py +0 -0
  145. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/utils/mermaid_diagram.py +0 -0
  146. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/utils/s3_upload.py +0 -0
  147. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/utils/topology.py +0 -0
  148. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/utils/unit_consistency.py +0 -0
  149. {processforge-0.4.3 → processforge-0.5.0}/src/processforge/utils/validation.py +0 -0
  150. {processforge-0.4.3 → processforge-0.5.0}/src/processforge.egg-info/dependency_links.txt +0 -0
  151. {processforge-0.4.3 → processforge-0.5.0}/src/processforge.egg-info/entry_points.txt +0 -0
  152. {processforge-0.4.3 → processforge-0.5.0}/src/processforge.egg-info/requires.txt +0 -0
  153. {processforge-0.4.3 → processforge-0.5.0}/src/processforge.egg-info/top_level.txt +0 -0
  154. {processforge-0.4.3 → processforge-0.5.0}/tests/test_container_client.py +0 -0
  155. {processforge-0.4.3 → processforge-0.5.0}/tests/test_display.py +0 -0
  156. {processforge-0.4.3 → processforge-0.5.0}/tests/test_festim_schema.py +0 -0
  157. {processforge-0.4.3 → processforge-0.5.0}/tests/test_fmu_solverunit.py +0 -0
  158. {processforge-0.4.3 → processforge-0.5.0}/tests/test_pathsim_adapter.py +0 -0
  159. {processforge-0.4.3 → processforge-0.5.0}/tests/test_persist.py +0 -0
  160. {processforge-0.4.3 → processforge-0.5.0}/tests/test_result_zarr.py +0 -0
  161. {processforge-0.4.3 → processforge-0.5.0}/tests/test_runs_command.py +0 -0
  162. {processforge-0.4.3 → processforge-0.5.0}/tests/test_s3_upload.py +0 -0
  163. {processforge-0.4.3 → processforge-0.5.0}/tests/test_state.py +0 -0
  164. {processforge-0.4.3 → processforge-0.5.0}/tests/test_types.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: processforge
3
- Version: 0.4.3
3
+ Version: 0.5.0
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
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "metadata": {
3
3
  "name": "Make-up Water System",
4
- "description": "A two-pump, five-valve, one-strainer, one tank steady-state make-up water system.",
4
+ "description": "A simple water system with a tank, pump, and valves.",
5
5
  "version": "2.0"
6
6
  },
7
7
  "providers": {
@@ -17,147 +17,141 @@
17
17
  "id": 2
18
18
  }
19
19
  },
20
- "streams": {
20
+ "streams": {
21
21
  "feed": {
22
22
  "T": 313.00,
23
23
  "P": 101325,
24
24
  "flowrate": 1,
25
- "z": { "Water": 1.0 }
25
+ "z": {
26
+ "Water": 1.0
27
+ }
26
28
  }
27
- },
28
-
29
- "units": {
29
+ },
30
+ "units": {
30
31
  "tank_1": {
31
32
  "type": "Tank",
32
- "in": ["feed"],
33
- "out": ["tank_1_to_pipe1", "tank_1_to_pipe2"],
33
+ "in": [
34
+ "feed"
35
+ ],
36
+ "out": [
37
+ "tank_1_to_pipe1",
38
+ "tank_1_to_pipe2"
39
+ ],
34
40
  "outlet_flow": 1.0,
35
- "initial_n": {
41
+ "initial_n": {
36
42
  "Water": 1.0
37
43
  },
38
44
  "initial_T": 298.15,
39
- "P": 101325,
45
+ "P": 101325,
40
46
  "material": 1
41
47
  },
42
-
43
-
44
- "pipe_1": {
48
+ "pipe_1": {
45
49
  "type": "Pipes",
46
50
  "in": "tank_1_to_pipe1",
47
51
  "out": "after_pipe_1",
48
52
  "delta_p": 1000.0,
49
53
  "diameter": 0.05,
50
54
  "material": 2
51
- },
52
-
53
-
54
-
55
- "low_pressure_pump":{
56
- "type": "Pump",
57
- "in": "after_pipe_1",
58
- "out": "after_low_pressure_pump",
59
- "q_flowrate": 4,
60
- "head": 57,
61
- "efficiency": 36,
62
- "power": 1.3,
63
- "cap": 2.5,
64
- "motor_rating": 370,
65
- "design_press": 6,
66
- "material": 2,
67
- "delta_p": 1000.0
68
- },
69
-
70
- "pipe_2": {
55
+ },
56
+ "low_pressure_pump": {
57
+ "type": "Pump",
58
+ "in": "after_pipe_1",
59
+ "out": "after_low_pressure_pump",
60
+ "q_flowrate": 4,
61
+ "head": 57,
62
+ "efficiency": 36,
63
+ "power": 1.3,
64
+ "cap": 2.5,
65
+ "motor_rating": 370,
66
+ "material": 2,
67
+ "delta_p": 1000.0
68
+ },
69
+ "pipe_2": {
71
70
  "type": "Pipes",
72
71
  "in": "tank_1_to_pipe2",
73
72
  "out": "after_pipe_2",
74
73
  "delta_p": 1000.0,
75
74
  "diameter": 0.05,
76
75
  "material": 2
77
- },
78
-
79
- "pipe_3": {
76
+ },
77
+ "pipe_3": {
80
78
  "type": "Pipes",
81
79
  "in": "after_low_pressure_pump",
82
80
  "out": "after_pipe_3",
83
81
  "delta_p": 1000.0,
84
82
  "diameter": 0.05,
85
83
  "material": 2
86
- },
87
-
88
-
84
+ },
89
85
  "drain_valve_1": {
90
- "type": "Valve",
91
- "in": "after_pipe_2",
92
- "out": "after_drain_valve_1",
93
- "opening": 50,
94
- "q_flowrate": 50,
95
- "material": 2,
96
- "pressure_ratio": 0.5
86
+ "type": "Valve",
87
+ "in": "after_pipe_2",
88
+ "out": "after_drain_valve_1",
89
+ "material": 2,
90
+ "valve_type": "drain",
91
+ "p_start_open": 2059396.5,
92
+ "p_full_open": 2451662.5,
93
+ "flow_min": 2.7778e-05,
94
+ "flow_max": 0.0013889
97
95
  },
98
-
99
96
  "make_up_valve_1": {
100
- "type": "Valve",
101
- "in": "after_pipe_3",
102
- "out": "after_make_up_valve_1",
103
- "opening": 50,
104
- "q_flowrate": 50,
105
- "material": 2,
106
- "pressure_ratio": 0.5
97
+ "type": "Valve",
98
+ "in": "after_pipe_3",
99
+ "out": "after_make_up_valve_1",
100
+ "material": 2,
101
+ "valve_type": "makeup",
102
+ "p_start_open": 1863273.5,
103
+ "p_full_open": 1470997.5,
104
+ "flow_min": 5.5556e-05,
105
+ "flow_max": 0.0016667
107
106
  },
108
-
109
- "pipe_4": {
107
+ "pipe_4": {
110
108
  "type": "Pipes",
111
109
  "in": "after_make_up_valve_1",
112
110
  "out": "after_pipe_4",
113
111
  "delta_p": 1000.0,
114
112
  "diameter": 0.05,
115
113
  "material": 2
116
- },
117
-
118
- "pipe_5": {
114
+ },
115
+ "pipe_5": {
119
116
  "type": "Pipes",
120
117
  "in": "after_drain_valve_1",
121
118
  "out": "after_pipe_5",
122
119
  "delta_p": 1000.0,
123
120
  "diameter": 0.05,
124
121
  "material": 2
125
- },
122
+ },
126
123
  "tank_2": {
127
124
  "type": "Tank",
128
- "in": ["after_pipe_4", "after_pipe_5"],
125
+ "in": [
126
+ "after_pipe_4",
127
+ "after_pipe_5"
128
+ ],
129
129
  "out": "after_tank_2",
130
130
  "outlet_flow": 1.0,
131
- "initial_n": {
131
+ "initial_n": {
132
132
  "Water": 1.0
133
133
  },
134
134
  "initial_T": 298.15,
135
- "P": 101325,
135
+ "P": 1961330,
136
136
  "material": 1
137
137
  },
138
-
139
- "pipe_6": {
138
+ "pipe_6": {
140
139
  "type": "Pipes",
141
140
  "in": "after_tank_2",
142
141
  "out": "after_pipe_6",
143
142
  "delta_p": 1000.0,
144
143
  "diameter": 0.05,
145
144
  "material": 2
146
- },
147
-
148
-
149
-
150
-
145
+ },
151
146
  "manual_drain_valve": {
152
- "type": "Valve",
153
- "in": "after_pipe_6",
154
- "out": "after_manual_drain_valve",
155
- "opening": 50,
156
- "q_flowrate": 50,
157
- "material": 2,
158
- "pressure_ratio": 0.5
147
+ "type": "Valve",
148
+ "in": "after_pipe_6",
149
+ "out": "after_manual_drain_valve",
150
+ "opening": 50,
151
+ "q_flowrate": 50,
152
+ "material": 2,
153
+ "pressure_ratio": 0.5
159
154
  }
160
-
161
155
  },
162
156
  "simulation": {
163
157
  "mode": "dynamic",
@@ -166,7 +160,4 @@
166
160
  "dt": 1.0,
167
161
  "backend": "scipy"
168
162
  }
169
- }
170
-
171
-
172
-
163
+ }
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "processforge"
7
- version = "0.4.3"
7
+ version = "0.5.0"
8
8
  description = "A Python-based process simulation framework for chemical engineering applications."
9
9
  readme = "README.md"
10
10
  license = "BSD-3-Clause"
@@ -30,7 +30,7 @@ from .units.flash import Flash
30
30
  from .units.heater import Heater
31
31
  from .eo import EOFlowsheet, EOSolver
32
32
 
33
- __version__ = "0.4.3"
33
+ __version__ = "0.5.0"
34
34
 
35
35
  __all__ = [
36
36
  "Flowsheet",
@@ -252,13 +252,13 @@ def _check_pip_provider(
252
252
  """Verify a pip-installable provider's module is importable."""
253
253
  from ..providers.registry import _PROVIDER_CATALOG
254
254
 
255
- catalog = _PROVIDER_CATALOG.get(ptype, {})
256
- module = catalog.get("module", "")
255
+ catalog = _PROVIDER_CATALOG.get(ptype)
256
+ module = catalog.module if catalog else ""
257
257
  try:
258
258
  importlib.util.find_spec(module)
259
259
  logger.info(f" [OK] {name} [{ptype}] (pip — importable)")
260
260
  except (ModuleNotFoundError, ValueError):
261
- dep = catalog.get("optional_dep")
261
+ dep = catalog.optional_dep if catalog else None
262
262
  hint = f"pip install 'processforge[{dep}]'" if dep else "built-in"
263
263
  msg = (
264
264
  f" [WARN] {name} [{ptype}] — not installed. "
@@ -23,6 +23,16 @@ back to the built-in CoolProp provider — existing flowsheets are unaffected.
23
23
  from .base import AbstractProvider
24
24
  from .base_jacobian_mixin import BaseJacobianMixin
25
25
  from .coolprop_provider import CoolPropProvider
26
+ from .errors import (
27
+ ProviderCleanupError,
28
+ ProviderConfigError,
29
+ ProviderError,
30
+ ProviderInitError,
31
+ ProviderNotAvailableError,
32
+ ProviderRunError,
33
+ ProviderRuntimeError,
34
+ ProviderValidationError,
35
+ )
26
36
  from .jacobian_contributor import JacobianContributor, ReferenceState
27
37
  from .reference_state_registry import ReferenceStateRegistry
28
38
  from .registry import get_provider_class, list_providers, register_provider
@@ -38,4 +48,14 @@ __all__ = [
38
48
  "ReferenceState",
39
49
  "BaseJacobianMixin",
40
50
  "ReferenceStateRegistry",
51
+ # Provider error taxonomy
52
+ "ProviderError",
53
+ "ProviderInitError",
54
+ "ProviderNotAvailableError",
55
+ "ProviderRuntimeError",
56
+ "ProviderCleanupError",
57
+ "ProviderValidationError",
58
+ "ProviderConfigError",
59
+ "ProviderRunError",
41
60
  ]
61
+
@@ -0,0 +1,70 @@
1
+ """Shared simulation-type strategy registry for engine providers.
2
+
3
+ Engine providers such as OpenMC and FESTIM support multiple ``sim_type`` values.
4
+ Each simulation type is implemented as a strategy class that builds the
5
+ engine-specific model for that type. This module provides the shared
6
+ infrastructure so new engines can reuse the same registration pattern.
7
+
8
+ Example::
9
+
10
+ from processforge.providers._sim_strategy import SimStrategy, register_sim_type
11
+
12
+ class MyEngineStrategy(SimStrategy):
13
+ config_model = MyGeometryConfig
14
+
15
+ def build(self, engine_module, solver_cfg, geometry_cfg, materials_map):
16
+ ...
17
+ return built_model
18
+
19
+ register_sim_type("my_engine", "my_sim", MyEngineStrategy)
20
+ """
21
+ from __future__ import annotations
22
+
23
+ from abc import ABC, abstractmethod
24
+ from typing import Any
25
+
26
+
27
+ class SimStrategy(ABC):
28
+ """Base class for an engine-specific simulation type.
29
+
30
+ Subclasses declare ``config_model`` — the Pydantic model validating the
31
+ per-strategy ``geometry_config`` block of the flowsheet — and implement
32
+ ``build`` to construct the engine model.
33
+ """
34
+
35
+ #: Pydantic model validating the unit's ``geometry_config`` block. ``None``
36
+ #: means the strategy takes no geometry config.
37
+ config_model: type | None = None
38
+
39
+ @abstractmethod
40
+ def build(self, **kwargs: Any) -> Any:
41
+ """Construct the engine model and return engine-specific objects."""
42
+
43
+
44
+ # Engine name -> sim_type name -> strategy class
45
+ _SIM_TYPE_REGISTRIES: dict[str, dict[str, type]] = {}
46
+
47
+
48
+ def register_sim_type(engine: str, name: str, strategy_cls: type) -> None:
49
+ """Register a simulation type for a given engine.
50
+
51
+ Args:
52
+ engine: Engine/provider name (e.g. ``"openmc"``, ``"festim"``).
53
+ name: The ``sim_type`` string used in the flowsheet JSON.
54
+ strategy_cls: A subclass of :class:`SimStrategy`.
55
+ """
56
+ _SIM_TYPE_REGISTRIES.setdefault(engine, {})[name] = strategy_cls
57
+
58
+
59
+ def get_registered_sim_types(engine: str) -> dict[str, type]:
60
+ """Return a copy of the sim_type → strategy mapping for *engine*.
61
+
62
+ Returns:
63
+ A dict mapping ``sim_type`` strings to strategy classes.
64
+ """
65
+ return dict(_SIM_TYPE_REGISTRIES.get(engine, {}))
66
+
67
+
68
+ def get_strategy(engine: str, sim_type: str) -> type | None:
69
+ """Return the strategy class for (*engine*, *sim_type*), or ``None``."""
70
+ return _SIM_TYPE_REGISTRIES.get(engine, {}).get(sim_type)
@@ -0,0 +1,92 @@
1
+ """BaseSimulationProvider — shared scaffolding for engine-style providers.
2
+
3
+ Engine providers (OpenMC, FESTIM, and future providers that run standalone
4
+ simulations via ``SolverUnit``) share a common lifecycle:
5
+
6
+ * they do not provide per-stream thermodynamics,
7
+ * they do not intercept ``compute_unit()`` calls,
8
+ * they keep a material registry built from the flowsheet,
9
+ * they resolve a writable run directory with a temp-dir fallback.
10
+
11
+ This base class captures those defaults so concrete providers only implement
12
+ ``initialize()`` and ``run_simulation()``.
13
+ """
14
+ from __future__ import annotations
15
+
16
+ import os
17
+ import pathlib
18
+ import tempfile
19
+ from abc import ABC
20
+ from typing import TYPE_CHECKING, Optional
21
+
22
+ from .base import AbstractProvider
23
+
24
+ if TYPE_CHECKING:
25
+ from processforge.types import FlowsheetConfig, ProviderConfig
26
+
27
+
28
+ class BaseSimulationProvider(AbstractProvider, ABC):
29
+ """Base class for providers that run standalone engine simulations.
30
+
31
+ Provides default implementations of ``get_thermo_properties``,
32
+ ``compute_unit``, and ``teardown``, plus a helper for resolving a writable
33
+ run directory.
34
+ """
35
+
36
+ def __init__(self) -> None:
37
+ self._materials: dict = {}
38
+ self._provider_output_dir: str = "outputs"
39
+ self._initialized: bool = False
40
+
41
+ def initialize(
42
+ self,
43
+ provider_config: "ProviderConfig",
44
+ flowsheet_config: "FlowsheetConfig",
45
+ ) -> None:
46
+ """Set up the provider. Must be implemented by subclasses."""
47
+ raise NotImplementedError(
48
+ f"{type(self).__name__} must implement initialize()"
49
+ )
50
+
51
+ def get_thermo_properties(self, stream: dict) -> dict:
52
+ """Stream thermodynamics are not supported by engine providers."""
53
+ raise NotImplementedError(
54
+ f"{type(self).__name__} does not support stream thermodynamics."
55
+ )
56
+
57
+ def compute_unit(self, unit_type: str, config: dict, inlet: dict):
58
+ """Engine providers use ``run_simulation()`` via ``SolverUnit``."""
59
+ return None
60
+
61
+ def teardown(self) -> None:
62
+ """Release provider state."""
63
+ self._initialized = False
64
+
65
+ def _resolve_run_dir(self) -> pathlib.Path:
66
+ """Create the run output directory, falling back to a temp dir on failure.
67
+
68
+ The configured output dir (often a mounted volume) may not be writable by
69
+ the current user. Fall back to a temp dir so the simulation can still run;
70
+ only the persisted artifacts are lost.
71
+ """
72
+ run_dir = pathlib.Path(self._provider_output_dir)
73
+ try:
74
+ run_dir.mkdir(parents=True, exist_ok=True)
75
+ except (PermissionError, OSError) as exc:
76
+ run_dir = pathlib.Path(tempfile.mkdtemp(prefix="processforge_"))
77
+ from loguru import logger
78
+
79
+ logger.warning(
80
+ f"{type(self).__name__}: cannot use output dir "
81
+ f"'{self._provider_output_dir}' ({exc}); "
82
+ f"falling back to '{run_dir}'."
83
+ )
84
+ return run_dir
85
+
86
+ def _expand_output_dir(self, output_dir: str) -> str:
87
+ """Expand env vars and anchor relative paths under the run output root."""
88
+ out_dir = os.path.expandvars(output_dir)
89
+ if not os.path.isabs(out_dir):
90
+ root = os.environ.get("PROCESSFORGE_OUTPUT_DIR", "outputs")
91
+ out_dir = os.path.join(root, out_dir)
92
+ return out_dir
@@ -7,6 +7,7 @@ from loguru import logger
7
7
 
8
8
  from .base import AbstractProvider
9
9
  from .cantera_jacobian import CanteraJacobianMixin
10
+ from .errors import ProviderNotAvailableError
10
11
  from .registry import register_provider
11
12
 
12
13
  if TYPE_CHECKING:
@@ -57,7 +58,7 @@ class CanteraProvider(AbstractProvider, CanteraJacobianMixin):
57
58
  try:
58
59
  import cantera as ct
59
60
  except ImportError as exc:
60
- raise RuntimeError(
61
+ raise ProviderNotAvailableError(
61
62
  "Cantera is not installed. "
62
63
  "Install it with: pip install 'processforge[cantera]'"
63
64
  ) from exc
@@ -24,6 +24,7 @@ from typing import TYPE_CHECKING, Optional
24
24
  from loguru import logger
25
25
 
26
26
  from .base import AbstractProvider
27
+ from .errors import ProviderNotAvailableError
27
28
  from .registry import get_provider_default_port
28
29
 
29
30
  if TYPE_CHECKING:
@@ -134,7 +135,7 @@ class ContainerProviderClient(AbstractProvider):
134
135
  f"status={health.get('status')}"
135
136
  )
136
137
  except (urllib.error.URLError, OSError, TimeoutError) as exc:
137
- raise RuntimeError(
138
+ raise ProviderNotAvailableError(
138
139
  f"Provider '{self._ptype}' service unreachable at {self._url}. "
139
140
  f"Ensure the container is running: pf init <flowsheet>"
140
141
  ) from exc
@@ -4,6 +4,7 @@ from __future__ import annotations
4
4
  from typing import TYPE_CHECKING, Optional
5
5
 
6
6
  from .base import AbstractProvider
7
+ from .errors import ProviderNotAvailableError
7
8
 
8
9
  if TYPE_CHECKING:
9
10
  from processforge.types import CoolPropProviderConfig, FlowsheetConfig
@@ -25,11 +26,11 @@ class CoolPropProvider(AbstractProvider):
25
26
  try:
26
27
  import CoolProp.CoolProp as CP
27
28
  self.CP = CP
28
- except ImportError:
29
- raise ImportError(
29
+ except ImportError as exc:
30
+ raise ProviderNotAvailableError(
30
31
  "CoolProp is not installed. To use the CoolProp thermodynamics provider, "
31
32
  "please install it by running `pip install \"processforge[coolprop]\"`"
32
- )
33
+ ) from exc
33
34
 
34
35
  def get_thermo_properties(self, stream: dict) -> dict:
35
36
  """Calculate thermodynamic properties using CoolProp."""