processforge 0.5.0__tar.gz → 0.5.1__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 (160) hide show
  1. {processforge-0.5.0/src/processforge.egg-info → processforge-0.5.1}/PKG-INFO +1 -1
  2. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/custom/crimson/simple_water_system.json +4 -2
  3. {processforge-0.5.0 → processforge-0.5.1}/pyproject.toml +1 -1
  4. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/__init__.py +1 -1
  5. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/apply.py +5 -3
  6. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/display.py +3 -3
  7. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/init.py +3 -3
  8. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/run.py +2 -6
  9. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/flowsheet.py +8 -1
  10. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/flowsheet.py +9 -1
  11. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/output_collector.py +25 -1
  12. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/base.py +13 -0
  13. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/container_client.py +19 -17
  14. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/manager.py +16 -1
  15. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/types.py +14 -0
  16. {processforge-0.5.0 → processforge-0.5.1/src/processforge.egg-info}/PKG-INFO +1 -1
  17. {processforge-0.5.0 → processforge-0.5.1}/tests/test_cli.py +11 -0
  18. {processforge-0.5.0 → processforge-0.5.1}/tests/test_container_client.py +56 -1
  19. {processforge-0.5.0 → processforge-0.5.1}/tests/test_providers.py +11 -0
  20. {processforge-0.5.0 → processforge-0.5.1}/tests/test_runs_command.py +48 -0
  21. {processforge-0.5.0 → processforge-0.5.1}/LICENSE +0 -0
  22. {processforge-0.5.0 → processforge-0.5.1}/MANIFEST.in +0 -0
  23. {processforge-0.5.0 → processforge-0.5.1}/README.md +0 -0
  24. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/closed-loop-chain.json +0 -0
  25. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/coupled/msre_coupled.json +0 -0
  26. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/custom/crimson/MUWS_HB.json +0 -0
  27. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/custom/simple_hyrdaulic_scheme.json +0 -0
  28. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/festim/hydrogen_transport_1d.json +0 -0
  29. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/festim/tds_tungsten.json +0 -0
  30. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/hydraulic-chain.json +0 -0
  31. {processforge-0.5.0 → processforge-0.5.1}/flowsheets/openmc/msre_eigenvalue.json +0 -0
  32. {processforge-0.5.0 → processforge-0.5.1}/setup.cfg +0 -0
  33. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/__main__.py +0 -0
  34. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/_schema.py +0 -0
  35. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/analysis/__init__.py +0 -0
  36. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/analysis/dof.py +0 -0
  37. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/api/__init__.py +0 -0
  38. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/api/serve.py +0 -0
  39. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/__init__.py +0 -0
  40. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/common.py +0 -0
  41. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/diagram.py +0 -0
  42. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/export_fmu.py +0 -0
  43. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/export_modelica.py +0 -0
  44. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/persist.py +0 -0
  45. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/plan.py +0 -0
  46. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/runs.py +0 -0
  47. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/cli/validate.py +0 -0
  48. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/compose.py +0 -0
  49. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/coupling.py +0 -0
  50. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/__init__.py +0 -0
  51. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/backends/__init__.py +0 -0
  52. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/backends/base.py +0 -0
  53. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/backends/casadi_backend.py +0 -0
  54. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/backends/pyomo_backend.py +0 -0
  55. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/backends/scipy_backend.py +0 -0
  56. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/jacobian.py +0 -0
  57. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/mixin.py +0 -0
  58. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/solver.py +0 -0
  59. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/stream_var.py +0 -0
  60. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/units/__init__.py +0 -0
  61. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/units/flash_eo.py +0 -0
  62. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/units/heater_eo.py +0 -0
  63. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/units/pipes_eo.py +0 -0
  64. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/units/pump_eo.py +0 -0
  65. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/units/strainer_eo.py +0 -0
  66. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/eo/units/valve_eo.py +0 -0
  67. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/fmu/__init__.py +0 -0
  68. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/fmu/_fmi_vars.py +0 -0
  69. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/fmu/builder.py +0 -0
  70. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/fmu/interface.py +0 -0
  71. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/fmu/slave_template.py +0 -0
  72. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/lock.py +0 -0
  73. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/modelica/__init__.py +0 -0
  74. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/modelica/mo_writer.py +0 -0
  75. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/modelica/omc_runner.py +0 -0
  76. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/modelica/transpiler.py +0 -0
  77. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/modelica/unit_equations.py +0 -0
  78. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/pathsim/__init__.py +0 -0
  79. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/pathsim/adapter.py +0 -0
  80. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/pcl/__init__.py +0 -0
  81. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/pcl/compiler.py +0 -0
  82. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/pcl/namespace.py +0 -0
  83. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/persistence/__init__.py +0 -0
  84. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/persistence/archive.py +0 -0
  85. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/persistence/artifact_store.py +0 -0
  86. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/provenance.py +0 -0
  87. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/__init__.py +0 -0
  88. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/_sim_strategy.py +0 -0
  89. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/base_jacobian_mixin.py +0 -0
  90. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/base_simulation_provider.py +0 -0
  91. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/cantera_jacobian.py +0 -0
  92. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/cantera_provider.py +0 -0
  93. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/coolprop_provider.py +0 -0
  94. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/errors.py +0 -0
  95. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/festim/__init__.py +0 -0
  96. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/festim/build_helpers.py +0 -0
  97. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/festim/provider.py +0 -0
  98. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/festim/result_extraction.py +0 -0
  99. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/festim/strategies.py +0 -0
  100. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/jacobian_contributor.py +0 -0
  101. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/modelica_jacobian.py +0 -0
  102. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/modelica_provider.py +0 -0
  103. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/openmc/__init__.py +0 -0
  104. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/openmc/build_helpers.py +0 -0
  105. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/openmc/provider.py +0 -0
  106. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/openmc/result_extraction.py +0 -0
  107. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/openmc/strategies.py +0 -0
  108. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/reference_state_registry.py +0 -0
  109. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/providers/registry.py +0 -0
  110. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/quantity.py +0 -0
  111. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/result.py +0 -0
  112. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/result_schema.py +0 -0
  113. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/schemas/__init__.py +0 -0
  114. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/schemas/festim/festim_model.py +0 -0
  115. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/schemas/flowsheet_schema.json +0 -0
  116. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/schemas/openmc/openmc_model.py +0 -0
  117. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/simulate.py +0 -0
  118. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/solver.py +0 -0
  119. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/state.py +0 -0
  120. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/thermo.py +0 -0
  121. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/__init__.py +0 -0
  122. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/base.py +0 -0
  123. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/cstr.py +0 -0
  124. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/flash.py +0 -0
  125. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/heater.py +0 -0
  126. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/pfr.py +0 -0
  127. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/pipes.py +0 -0
  128. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/pump.py +0 -0
  129. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/registry.py +0 -0
  130. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/solver_unit.py +0 -0
  131. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/strainer.py +0 -0
  132. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/tank.py +0 -0
  133. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/units/valve.py +0 -0
  134. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/utils/__init__.py +0 -0
  135. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/utils/flowsheet_diagram.py +0 -0
  136. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/utils/mermaid_diagram.py +0 -0
  137. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/utils/s3_upload.py +0 -0
  138. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/utils/topology.py +0 -0
  139. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/utils/unit_consistency.py +0 -0
  140. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/utils/validate_flowsheet.py +0 -0
  141. {processforge-0.5.0 → processforge-0.5.1}/src/processforge/utils/validation.py +0 -0
  142. {processforge-0.5.0 → processforge-0.5.1}/src/processforge.egg-info/SOURCES.txt +0 -0
  143. {processforge-0.5.0 → processforge-0.5.1}/src/processforge.egg-info/dependency_links.txt +0 -0
  144. {processforge-0.5.0 → processforge-0.5.1}/src/processforge.egg-info/entry_points.txt +0 -0
  145. {processforge-0.5.0 → processforge-0.5.1}/src/processforge.egg-info/requires.txt +0 -0
  146. {processforge-0.5.0 → processforge-0.5.1}/src/processforge.egg-info/top_level.txt +0 -0
  147. {processforge-0.5.0 → processforge-0.5.1}/tests/test_coupling.py +0 -0
  148. {processforge-0.5.0 → processforge-0.5.1}/tests/test_display.py +0 -0
  149. {processforge-0.5.0 → processforge-0.5.1}/tests/test_festim_provider.py +0 -0
  150. {processforge-0.5.0 → processforge-0.5.1}/tests/test_festim_schema.py +0 -0
  151. {processforge-0.5.0 → processforge-0.5.1}/tests/test_fmu_solverunit.py +0 -0
  152. {processforge-0.5.0 → processforge-0.5.1}/tests/test_init.py +0 -0
  153. {processforge-0.5.0 → processforge-0.5.1}/tests/test_openmc_provider.py +0 -0
  154. {processforge-0.5.0 → processforge-0.5.1}/tests/test_pathsim_adapter.py +0 -0
  155. {processforge-0.5.0 → processforge-0.5.1}/tests/test_persist.py +0 -0
  156. {processforge-0.5.0 → processforge-0.5.1}/tests/test_provider_errors.py +0 -0
  157. {processforge-0.5.0 → processforge-0.5.1}/tests/test_result_zarr.py +0 -0
  158. {processforge-0.5.0 → processforge-0.5.1}/tests/test_s3_upload.py +0 -0
  159. {processforge-0.5.0 → processforge-0.5.1}/tests/test_state.py +0 -0
  160. {processforge-0.5.0 → processforge-0.5.1}/tests/test_types.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: processforge
3
- Version: 0.5.0
3
+ Version: 0.5.1
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
@@ -91,7 +91,8 @@
91
91
  "p_start_open": 2059396.5,
92
92
  "p_full_open": 2451662.5,
93
93
  "flow_min": 2.7778e-05,
94
- "flow_max": 0.0013889
94
+ "flow_max": 0.0013889,
95
+ "pressure_ratio": 0.5
95
96
  },
96
97
  "make_up_valve_1": {
97
98
  "type": "Valve",
@@ -102,7 +103,8 @@
102
103
  "p_start_open": 1863273.5,
103
104
  "p_full_open": 1470997.5,
104
105
  "flow_min": 5.5556e-05,
105
- "flow_max": 0.0016667
106
+ "flow_max": 0.0016667,
107
+ "pressure_ratio": 0.5
106
108
  },
107
109
  "pipe_4": {
108
110
  "type": "Pipes",
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "processforge"
7
- version = "0.5.0"
7
+ version = "0.5.1"
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.5.0"
33
+ __version__ = "0.5.1"
34
34
 
35
35
  __all__ = [
36
36
  "Flowsheet",
@@ -9,7 +9,7 @@ from typing import Literal
9
9
  import typer
10
10
  from loguru import logger
11
11
 
12
- from .persist import make_run_id, persist_run
12
+ from .persist import flowsheet_hash, make_run_id, persist_run
13
13
  from ..eo import EOFlowsheet
14
14
  from ..provenance import build_run_info
15
15
  from .common import (
@@ -106,6 +106,8 @@ def apply(
106
106
  fs.solver_max_iter = max_iter
107
107
 
108
108
  logger.info("=== Running Apply (Steady-State EO) ===")
109
+ run_id = make_run_id()
110
+ fs.set_run_context(run_id, flowsheet_hash(config))
109
111
  t0 = time.perf_counter()
110
112
  results = fs.run()
111
113
  elapsed = time.perf_counter() - t0
@@ -122,7 +124,6 @@ def apply(
122
124
  label="converged state",
123
125
  )
124
126
  run_info = build_run_info(config, x0=fs.x0, var_names=fs.var_names)
125
- run_id = make_run_id()
126
127
  persist_run(sm, fs, run_id, results, run_info, config, base_name, snapshot_id)
127
128
  logger.info("=== Apply Summary ===")
128
129
  logger.info(" Status : CONVERGED")
@@ -142,7 +143,9 @@ def apply(
142
143
  from ..providers.manager import teardown_providers
143
144
 
144
145
  solver = EOSolver(backend=fs.backend, tol=tolerance, max_iter=max_iter)
146
+ run_id = make_run_id()
145
147
  tmp_fs = _EO(config, backend=backend)
148
+ tmp_fs.set_run_context(run_id, flowsheet_hash(config))
146
149
  manager = tmp_fs._build()
147
150
  try:
148
151
  homotopy_result = solve_with_homotopy(tmp_fs, manager, solver, state, drifted)
@@ -168,7 +171,6 @@ def apply(
168
171
  label="homotopy solution",
169
172
  )
170
173
  run_info = build_run_info(config, x0=fs.x0, var_names=fs.var_names)
171
- run_id = make_run_id()
172
174
  persist_run(sm, tmp_fs, run_id, tmp_fs.results, run_info, config, base_name, snapshot_id)
173
175
  logger.info("Homotopy apply succeeded. New snapshot saved.")
174
176
  return
@@ -96,13 +96,13 @@ def print_provider_health(config: dict, strict: bool = False) -> list[str]:
96
96
  logger.error(msg)
97
97
  failures.append(f"Provider '{name}' unreachable at {url}: {info}")
98
98
  else:
99
- catalog = _PROVIDER_CATALOG.get(ptype, {})
100
- module = catalog.get("module", "")
99
+ catalog = _PROVIDER_CATALOG.get(ptype)
100
+ module = catalog.module if catalog else ""
101
101
  try:
102
102
  importlib.util.find_spec(module)
103
103
  logger.info(f" [OK] {name} [{ptype}] (pip — importable)")
104
104
  except (ModuleNotFoundError, ValueError):
105
- dep = catalog.get("optional_dep")
105
+ dep = catalog.optional_dep if catalog else None
106
106
  hint = f"pip install 'processforge[{dep}]'" if dep else "built-in"
107
107
  logger.warning(f" [WARN] {name} [{ptype}] — not installed ({hint})")
108
108
  if strict:
@@ -208,13 +208,13 @@ def init(
208
208
  # Validate pip providers are importable
209
209
  for name, info in pip_providers.items():
210
210
  ptype = info["type"]
211
- catalog = _PROVIDER_CATALOG.get(ptype, {})
212
- module = catalog.get("module", "")
211
+ catalog = _PROVIDER_CATALOG.get(ptype)
212
+ module = catalog.module if catalog else ""
213
213
  try:
214
214
  importlib.util.find_spec(module)
215
215
  logger.info(f" {name} — importable")
216
216
  except (ModuleNotFoundError, ValueError):
217
- dep = catalog.get("optional_dep")
217
+ dep = catalog.optional_dep if catalog else None
218
218
  hint = f"pip install 'processforge[{dep}]'" if dep else "built-in"
219
219
  logger.warning(f" {name} — not installed. Install with: {hint}")
220
220
 
@@ -106,6 +106,7 @@ def run(
106
106
  logger.debug("No .pfarchive found — starting dynamic run from flowsheet defaults.")
107
107
 
108
108
  fs = Flowsheet(config)
109
+ fs.set_run_context(run_id, flowsheet_hash_value)
109
110
  logger.info("=== Dynamic Results ===")
110
111
  results = fs.run()
111
112
 
@@ -128,6 +129,7 @@ def run(
128
129
  else:
129
130
  # Pass None so EOFlowsheet resolves backend from config (with scipy default).
130
131
  fs = EOFlowsheet(config, backend=None)
132
+ fs.set_run_context(run_id, flowsheet_hash_value)
131
133
  logger.info("=== Steady-State EO Results ===")
132
134
  results = fs.run()
133
135
 
@@ -144,12 +146,6 @@ def run(
144
146
  snap_backend = getattr(fs, "backend", "scipy")
145
147
  snap_ok = bool(getattr(fs, "converged", False))
146
148
 
147
- # Propagate run context to any containerized providers so their S3 uploads
148
- # are keyed by the same run_id/flowsheet_hash as this archive run.
149
- for provider in getattr(fs, "_provider_map", {}).values():
150
- if hasattr(provider, "set_run_context"):
151
- provider.set_run_context(run_id, flowsheet_hash_value)
152
-
153
149
  # Build + persist the standardized run manifest.
154
150
  archive_path = os.path.join(outputs_dir, f"{base_name}.pfarchive")
155
151
  archive = ProcessStateArchive(archive_path)
@@ -51,6 +51,12 @@ class EOFlowsheet:
51
51
  self.solver_tol: float = 1e-6
52
52
  self.solver_max_iter: int = 50
53
53
 
54
+ def set_run_context(self, run_id: str | None = None, flowsheet_hash: str | None = None) -> None:
55
+ """Store run-level metadata so containerized providers can tag artifacts."""
56
+ from processforge.types import RunContext
57
+
58
+ self._run_context = RunContext(run_id=run_id, flowsheet_hash=flowsheet_hash)
59
+
54
60
  # ------------------------------------------------------------------
55
61
  # Public API
56
62
  # ------------------------------------------------------------------
@@ -68,8 +74,9 @@ class EOFlowsheet:
68
74
  Stream result dict in the same format as ``Flowsheet.run()``:
69
75
  ``{stream_name: {"T": ..., "P": ..., "flowrate": ..., "z": {...}}}``
70
76
  """
71
- from processforge.providers.manager import teardown_providers
77
+ from processforge.providers.manager import apply_run_context, teardown_providers
72
78
  manager = self._build()
79
+ apply_run_context(self._provider_map, getattr(self, "_run_context", None))
73
80
  self.engine_outputs: dict = {}
74
81
  try:
75
82
  x0 = self._warm_start(manager)
@@ -9,7 +9,7 @@ from copy import deepcopy
9
9
  if TYPE_CHECKING:
10
10
  from .providers.manager import ProviderMap
11
11
 
12
- from .providers.manager import build_provider_map, teardown_providers
12
+ from .providers.manager import apply_run_context, build_provider_map, teardown_providers
13
13
  from .types import EngineOutput, FlowsheetConfig, MergedInletTimeseries, StreamTimeseries
14
14
  from .solver import Solver
15
15
  from .providers.manager import UnitProviderConfig
@@ -112,6 +112,12 @@ class Flowsheet:
112
112
  self.tear_streams = set()
113
113
  self.has_recycles = False
114
114
 
115
+ def set_run_context(self, run_id: str | None = None, flowsheet_hash: str | None = None) -> None:
116
+ """Store run-level metadata so containerized providers can tag artifacts."""
117
+ from processforge.types import RunContext
118
+
119
+ self._run_context = RunContext(run_id=run_id, flowsheet_hash=flowsheet_hash)
120
+
115
121
  def build_units(self, provider_map: ProviderMap | None = None):
116
122
  logger.info("Building units")
117
123
  _merge_provider_types(provider_map=provider_map)
@@ -228,6 +234,8 @@ class Flowsheet:
228
234
  logger.info("Starting simulation")
229
235
  flowsheet_cfg = FlowsheetConfig.from_dict(self.config)
230
236
  provider_map = build_provider_map(providers_config=flowsheet_cfg.providers, flowsheet_config=flowsheet_cfg)
237
+ self._provider_map = provider_map
238
+ apply_run_context(provider_map, getattr(self, "_run_context", None))
231
239
  self.engine_outputs: dict = {}
232
240
  try:
233
241
  self.build_units(provider_map=provider_map)
@@ -18,6 +18,7 @@ from datetime import datetime, timezone
18
18
  from typing import Optional
19
19
 
20
20
  import arrow
21
+ import numpy as np
21
22
  from loguru import logger
22
23
 
23
24
  from .types import (
@@ -30,6 +31,26 @@ from .types import (
30
31
  )
31
32
 
32
33
 
34
+ def _to_scalar(value):
35
+ """Return the last element of a sequence, or the scalar value itself.
36
+
37
+ Dynamic simulations store stream properties as timeseries lists. For
38
+ manifest-level thermo output we use the final timestep as the representative
39
+ scalar, matching the convention used by :func:`~processforge.result.plot_results`.
40
+ """
41
+ if isinstance(value, (list, tuple, np.ndarray)):
42
+ arr = np.asarray(value)
43
+ if arr.size == 0:
44
+ raise ValueError("empty sequence")
45
+ candidate = arr[-1]
46
+ else:
47
+ candidate = value
48
+ try:
49
+ return float(candidate)
50
+ except (TypeError, ValueError) as exc:
51
+ raise ValueError(f"non-numeric value {candidate!r}") from exc
52
+
53
+
33
54
  def collect_stream_outputs(provider, stream_results: dict) -> dict[str, StreamOutput]:
34
55
  """Build :class:`StreamOutput` for each stream using *provider*'s thermo."""
35
56
  if provider is None:
@@ -44,7 +65,10 @@ def collect_stream_outputs(provider, stream_results: dict) -> dict[str, StreamOu
44
65
  if not isinstance(z, dict) or T is None or P is None:
45
66
  continue
46
67
  try:
47
- props = provider.get_thermo_properties({"z": z, "T": T, "P": P})
68
+ z_norm = {comp: _to_scalar(frac) for comp, frac in z.items()}
69
+ T_norm = _to_scalar(T)
70
+ P_norm = _to_scalar(P)
71
+ props = provider.get_thermo_properties({"z": z_norm, "T": T_norm, "P": P_norm})
48
72
  except Exception as exc: # noqa: BLE001
49
73
  logger.debug(f"thermo properties unavailable for stream '{name}': {exc}")
50
74
  continue
@@ -10,6 +10,7 @@ if TYPE_CHECKING:
10
10
  FlowsheetConfig,
11
11
  MaterialDef,
12
12
  ProviderConfig,
13
+ RunContext,
13
14
  UnitConfig,
14
15
  )
15
16
 
@@ -87,6 +88,18 @@ class AbstractProvider(ABC):
87
88
  def teardown(self) -> None:
88
89
  """Release managed resources (FMU instances, Cantera solutions, etc.)."""
89
90
 
91
+ def set_run_context(self, context: "RunContext") -> None:
92
+ """Attach run-level orchestration metadata to this provider instance.
93
+
94
+ Called by the framework before a flowsheet run begins. The default
95
+ implementation is a no-op; providers that produce run-scoped artifacts
96
+ (e.g. the containerized HTTP client) may override this to capture the
97
+ context and forward it as needed.
98
+
99
+ Args:
100
+ context: Run identity and related metadata for this execution.
101
+ """
102
+
90
103
  # ------------------------------------------------------------------
91
104
  # Simulation provider interface (optional — override for FEM/neutronics)
92
105
  # ------------------------------------------------------------------
@@ -33,6 +33,7 @@ if TYPE_CHECKING:
33
33
  FlowsheetConfig,
34
34
  MaterialDef,
35
35
  ProviderConfig,
36
+ RunContext,
36
37
  UnitConfig,
37
38
  )
38
39
 
@@ -57,15 +58,13 @@ class ContainerProviderClient(AbstractProvider):
57
58
  self._provider_config: Optional["ProviderConfig"] = None
58
59
  self._materials: dict = {}
59
60
  self._initialized: bool = False
60
- # Run context, set by the CLI so container-side artifact uploads carry
61
- # the same run_id / flowsheet_hash as the on-host ProcessStateArchive.
62
- self._run_id: str = ""
63
- self._flowsheet_hash: str = ""
61
+ # Run context, set by the framework so container-side artifact uploads
62
+ # carry the same run_id / flowsheet_hash as the on-host archive.
63
+ self._run_context: Optional["RunContext"] = None
64
64
 
65
- def set_run_context(self, run_id: str, flowsheet_hash: str = "") -> None:
66
- """Associate subsequent /run calls with a CLI-generated run id."""
67
- self._run_id = run_id
68
- self._flowsheet_hash = flowsheet_hash
65
+ def set_run_context(self, context: "RunContext") -> None:
66
+ """Store run-level metadata for subsequent /run calls."""
67
+ self._run_context = context
69
68
 
70
69
  # ------------------------------------------------------------------
71
70
  # Helpers
@@ -155,9 +154,13 @@ class ContainerProviderClient(AbstractProvider):
155
154
  """Release provider state."""
156
155
  self._initialized = False
157
156
 
158
- def run_simulation(self, unit_config: "UnitConfig", inlet: dict, run_id: str | None = None, flowsheet_hash: str | None = None) -> "EngineOutput":
157
+ def run_simulation(self, unit_config: "UnitConfig", inlet: dict) -> "EngineOutput":
159
158
  """Serialise the request, POST it to the container, return the result.
160
159
 
160
+ Run context (run_id / flowsheet_hash) is read from the context set by
161
+ ``set_run_context`` and forwarded in the request body so the container's
162
+ artifact uploads are keyed consistently with the on-host archive.
163
+
161
164
  The container returns a serialized :class:`EngineOutput`. Artifact
162
165
  ``local_path`` values point at files *inside* the container and are not
163
166
  reachable from the CLI, so any artifact that carries ``remote_uris``
@@ -178,14 +181,13 @@ class ContainerProviderClient(AbstractProvider):
178
181
  else {"type": unit_config.provider or self._ptype, "url": self._url}
179
182
  )
180
183
 
181
- # Fall back to context set via set_run_context() (the CLI propagates the
182
- # shared run_id/flowsheet_hash there). SolverUnit calls run_simulation()
183
- # without these arguments, so without the fallback the container receives
184
- # null and artifacts get uploaded under the wrong key.
185
- if run_id is None:
186
- run_id = self._run_id or None
187
- if flowsheet_hash is None:
188
- flowsheet_hash = self._flowsheet_hash or None
184
+ # Read run context set by the framework. Empty strings are sent when no
185
+ # context is set so the container server can still log the run_id field.
186
+ run_id = ""
187
+ flowsheet_hash = ""
188
+ if self._run_context is not None:
189
+ run_id = self._run_context.run_id or ""
190
+ flowsheet_hash = self._run_context.flowsheet_hash or ""
189
191
 
190
192
  body = {
191
193
  "unit_config": self._serialize_unit_config(unit_config),
@@ -17,7 +17,7 @@ from typing import Optional
17
17
  from loguru import logger
18
18
  from pydantic import BaseModel, ConfigDict
19
19
 
20
- from processforge.types import CoolPropProviderConfig, FlowsheetConfig, ProviderConfig
20
+ from processforge.types import CoolPropProviderConfig, FlowsheetConfig, ProviderConfig, RunContext
21
21
 
22
22
  from .base import AbstractProvider
23
23
  from .coolprop_provider import CoolPropProvider
@@ -181,6 +181,21 @@ def build_provider_map(
181
181
  return ProviderMap(providers=providers, default=default)
182
182
 
183
183
 
184
+ def apply_run_context(
185
+ provider_map: ProviderMap | None,
186
+ context: RunContext | None,
187
+ ) -> None:
188
+ """Propagate run-level metadata to every provider in *provider_map*.
189
+
190
+ Providers that do not consume run context (e.g. CoolProp) inherit a no-op
191
+ implementation from ``AbstractProvider``.
192
+ """
193
+ if provider_map is None or context is None:
194
+ return
195
+ for provider in provider_map.values():
196
+ provider.set_run_context(context)
197
+
198
+
184
199
  def teardown_providers(provider_map: ProviderMap | None) -> None:
185
200
  """Call ``teardown()`` on every provider in the map.
186
201
 
@@ -8,6 +8,7 @@ Adding a new provider never requires changes to these models.
8
8
  """
9
9
  from __future__ import annotations
10
10
 
11
+ from dataclasses import dataclass
11
12
  from typing import Optional, Union
12
13
 
13
14
  import numpy as np
@@ -16,6 +17,19 @@ from pydantic import BaseModel, ConfigDict, Field
16
17
  from .quantity import Quantity
17
18
 
18
19
 
20
+ @dataclass(frozen=True)
21
+ class RunContext:
22
+ """Orchestration metadata for one flowsheet run.
23
+
24
+ Passed to providers via ``AbstractProvider.set_run_context`` so backends
25
+ can tag artifacts, logs, and provenance with the same run identity the
26
+ CLI archive uses.
27
+ """
28
+
29
+ run_id: Optional[str] = None
30
+ flowsheet_hash: Optional[str] = None
31
+
32
+
19
33
  class MaterialDef(BaseModel):
20
34
  """Framework-level representation of a material loaded from the flowsheet JSON.
21
35
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: processforge
3
- Version: 0.5.0
3
+ Version: 0.5.1
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
@@ -322,6 +322,17 @@ class TestCmdInit:
322
322
  assert any("non-empty" in m for m in log_output)
323
323
  assert any("providers" in m for m in log_output)
324
324
 
325
+ def test_init_with_coolprop_provider(self, tmp_path, coolprop_flowsheet, log_output):
326
+ from processforge.cli.init import init
327
+ from processforge.lock import read_lock
328
+
329
+ init(flowsheet=str(coolprop_flowsheet), path=str(tmp_path))
330
+ assert (tmp_path / ".processforge" / "config.json").exists()
331
+ lock = read_lock(str(tmp_path / ".processforge"), str(coolprop_flowsheet))
332
+ assert lock is not None
333
+ assert "coolprop" in lock["providers"]
334
+ assert any("initialised successfully" in m for m in log_output)
335
+
325
336
 
326
337
  # ---------------------------------------------------------------------------
327
338
  # cli/validate.py
@@ -4,7 +4,7 @@ import json
4
4
  import urllib.request
5
5
 
6
6
  from processforge.providers.container_client import ContainerProviderClient
7
- from processforge.types import UnitConfig
7
+ from processforge.types import RunContext, UnitConfig
8
8
 
9
9
 
10
10
  def test_serialize_unit_config_includes_geometry_config():
@@ -91,3 +91,58 @@ def test_run_simulation_body_excludes_output_dir(monkeypatch):
91
91
 
92
92
  assert "output_dir" not in captured["body"]
93
93
  assert "provider_config" in captured["body"]
94
+ assert captured["body"]["run_id"] == ""
95
+ assert captured["body"]["flowsheet_hash"] == ""
96
+
97
+
98
+ def test_run_simulation_sends_run_context(monkeypatch):
99
+ """Run context set via set_run_context is forwarded in the POST body."""
100
+ captured = {}
101
+
102
+ class _Resp:
103
+ def __enter__(self):
104
+ return self
105
+
106
+ def __exit__(self, *exc):
107
+ return False
108
+
109
+ def read(self):
110
+ return json.dumps(
111
+ {
112
+ "status": "completed",
113
+ "engine": "openmc",
114
+ "sim_type": "eigenvalue_reactor",
115
+ "fields": [],
116
+ "artifacts": [],
117
+ "diagnostics": {},
118
+ }
119
+ ).encode()
120
+
121
+ def _urlopen(req, timeout=0):
122
+ if req.full_url.endswith("/health"):
123
+ resp = _Resp()
124
+ resp.read = lambda: json.dumps({"status": "ready"}).encode()
125
+ return resp
126
+ captured["body"] = json.loads(req.data.decode())
127
+ return _Resp()
128
+
129
+ monkeypatch.setattr(urllib.request, "urlopen", _urlopen)
130
+
131
+ client = ContainerProviderClient("openmc")
132
+ client.initialize(
133
+ type("Cfg", (), {"url": "http://localhost:9000", "output_dir": "outputs/openmc", "model_dump": lambda self: {"url": "http://localhost:9000", "output_dir": "outputs/openmc"}})(),
134
+ type("FS", (), {"materials": {}})(),
135
+ )
136
+ client.set_run_context(RunContext(run_id="run-123", flowsheet_hash="abc"))
137
+ client.run_simulation(
138
+ UnitConfig(
139
+ type="SolverUnit",
140
+ provider="openmc",
141
+ material=3,
142
+ sim_type="eigenvalue_reactor",
143
+ ),
144
+ inlet={},
145
+ )
146
+
147
+ assert captured["body"]["run_id"] == "run-123"
148
+ assert captured["body"]["flowsheet_hash"] == "abc"
@@ -141,6 +141,17 @@ class TestProviderContract:
141
141
  f"Provider '{name}' ({cls.__name__}) has no 'teardown' method."
142
142
  )
143
143
 
144
+ def test_all_providers_have_set_run_context(self):
145
+ for name, cls in _PROVIDERS.items():
146
+ assert hasattr(cls, "set_run_context"), (
147
+ f"Provider '{name}' ({cls.__name__}) has no 'set_run_context' method."
148
+ )
149
+
150
+ def test_container_provider_overrides_set_run_context(self):
151
+ from processforge.providers.container_client import ContainerProviderClient
152
+
153
+ assert ContainerProviderClient.set_run_context is not AbstractProvider.set_run_context
154
+
144
155
 
145
156
  # ---------------------------------------------------------------------------
146
157
  # 3. Registry consistency
@@ -13,6 +13,7 @@ from processforge.cli.runs import runs
13
13
  from processforge.output_collector import (
14
14
  _timestamp_from_run_id,
15
15
  build_run_manifest,
16
+ collect_stream_outputs,
16
17
  )
17
18
  from processforge.result import relink_latest_results, save_results_zarr
18
19
  from processforge.types import (
@@ -237,3 +238,50 @@ def test_timestamp_from_run_id_falls_back_to_now():
237
238
  ts = _timestamp_from_run_id("not_a_real_run_id")
238
239
  assert arrow.get(ts) # valid ISO-8601
239
240
  assert ts.endswith(("+00:00", "Z"))
241
+
242
+
243
+ class FakeProvider:
244
+ def __init__(self):
245
+ self.calls = []
246
+
247
+ def get_thermo_properties(self, stream: dict) -> dict:
248
+ self.calls.append(stream)
249
+ return {
250
+ "H": 1234.5,
251
+ "Cp": 75.3,
252
+ "K_values": {"Water": 0.9, "Ethanol": 1.1},
253
+ }
254
+
255
+
256
+ def test_collect_stream_outputs_handles_dynamic_timeseries():
257
+ """Dynamic simulations store T/P/z as lists; collector must normalize them."""
258
+ provider = FakeProvider()
259
+ stream_results = {
260
+ "after_valve": {
261
+ "P": [101325.0, 101325.0, 150000.0],
262
+ "T": [298.15, 307.5, 313.0],
263
+ "flowrate": [1.0, 1.0, 1.0],
264
+ "time": [0.0, 1.0, 2.0],
265
+ "z": {
266
+ "Water": [1.0, 1.0, 1.0],
267
+ "Ethanol": [0.0, 0.0, 0.0],
268
+ },
269
+ },
270
+ }
271
+
272
+ outputs = collect_stream_outputs(provider, stream_results)
273
+
274
+ assert "after_valve" in outputs
275
+ stream_output = outputs["after_valve"]
276
+ assert stream_output.stream == "after_valve"
277
+ assert stream_output.engine == "fake"
278
+
279
+ field_names = {f.name for f in stream_output.fields}
280
+ assert field_names == {"H", "Cp", "K_values"}
281
+
282
+ # Ensure the final timestep values were passed to the provider.
283
+ assert len(provider.calls) == 1
284
+ call = provider.calls[0]
285
+ assert call["T"] == 313.0
286
+ assert call["P"] == 150000.0
287
+ assert call["z"] == {"Water": 1.0, "Ethanol": 0.0}
File without changes
File without changes
File without changes
File without changes