processforge 0.5.1__tar.gz → 0.6.2__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 (165) hide show
  1. {processforge-0.5.1/src/processforge.egg-info → processforge-0.6.2}/PKG-INFO +18 -1
  2. {processforge-0.5.1 → processforge-0.6.2}/README.md +17 -0
  3. {processforge-0.5.1 → processforge-0.6.2}/pyproject.toml +1 -1
  4. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/__init__.py +44 -24
  5. processforge-0.6.2/src/processforge/cli/apply.py +55 -0
  6. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/persist.py +3 -6
  7. processforge-0.6.2/src/processforge/cli/run.py +30 -0
  8. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/persistence/archive.py +34 -51
  9. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/persistence/artifact_store.py +94 -6
  10. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/result.py +0 -28
  11. processforge-0.6.2/src/processforge/runner.py +788 -0
  12. {processforge-0.5.1 → processforge-0.6.2/src/processforge.egg-info}/PKG-INFO +18 -1
  13. {processforge-0.5.1 → processforge-0.6.2}/src/processforge.egg-info/SOURCES.txt +3 -0
  14. processforge-0.6.2/tests/test_artifact_store.py +84 -0
  15. {processforge-0.5.1 → processforge-0.6.2}/tests/test_cli.py +41 -154
  16. processforge-0.6.2/tests/test_runner.py +141 -0
  17. {processforge-0.5.1 → processforge-0.6.2}/tests/test_runs_command.py +1 -34
  18. processforge-0.5.1/src/processforge/cli/apply.py +0 -209
  19. processforge-0.5.1/src/processforge/cli/run.py +0 -221
  20. {processforge-0.5.1 → processforge-0.6.2}/LICENSE +0 -0
  21. {processforge-0.5.1 → processforge-0.6.2}/MANIFEST.in +0 -0
  22. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/closed-loop-chain.json +0 -0
  23. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/coupled/msre_coupled.json +0 -0
  24. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/custom/crimson/MUWS_HB.json +0 -0
  25. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/custom/crimson/simple_water_system.json +0 -0
  26. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/custom/simple_hyrdaulic_scheme.json +0 -0
  27. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/festim/hydrogen_transport_1d.json +0 -0
  28. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/festim/tds_tungsten.json +0 -0
  29. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/hydraulic-chain.json +0 -0
  30. {processforge-0.5.1 → processforge-0.6.2}/flowsheets/openmc/msre_eigenvalue.json +0 -0
  31. {processforge-0.5.1 → processforge-0.6.2}/setup.cfg +0 -0
  32. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/__main__.py +0 -0
  33. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/_schema.py +0 -0
  34. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/analysis/__init__.py +0 -0
  35. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/analysis/dof.py +0 -0
  36. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/api/__init__.py +0 -0
  37. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/api/serve.py +0 -0
  38. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/__init__.py +0 -0
  39. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/common.py +0 -0
  40. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/diagram.py +0 -0
  41. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/display.py +0 -0
  42. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/export_fmu.py +0 -0
  43. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/export_modelica.py +0 -0
  44. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/init.py +0 -0
  45. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/plan.py +0 -0
  46. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/runs.py +0 -0
  47. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/cli/validate.py +0 -0
  48. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/compose.py +0 -0
  49. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/coupling.py +0 -0
  50. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/__init__.py +0 -0
  51. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/backends/__init__.py +0 -0
  52. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/backends/base.py +0 -0
  53. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/backends/casadi_backend.py +0 -0
  54. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/backends/pyomo_backend.py +0 -0
  55. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/backends/scipy_backend.py +0 -0
  56. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/flowsheet.py +0 -0
  57. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/jacobian.py +0 -0
  58. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/mixin.py +0 -0
  59. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/solver.py +0 -0
  60. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/stream_var.py +0 -0
  61. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/units/__init__.py +0 -0
  62. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/units/flash_eo.py +0 -0
  63. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/units/heater_eo.py +0 -0
  64. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/units/pipes_eo.py +0 -0
  65. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/units/pump_eo.py +0 -0
  66. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/units/strainer_eo.py +0 -0
  67. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/eo/units/valve_eo.py +0 -0
  68. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/flowsheet.py +0 -0
  69. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/fmu/__init__.py +0 -0
  70. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/fmu/_fmi_vars.py +0 -0
  71. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/fmu/builder.py +0 -0
  72. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/fmu/interface.py +0 -0
  73. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/fmu/slave_template.py +0 -0
  74. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/lock.py +0 -0
  75. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/modelica/__init__.py +0 -0
  76. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/modelica/mo_writer.py +0 -0
  77. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/modelica/omc_runner.py +0 -0
  78. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/modelica/transpiler.py +0 -0
  79. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/modelica/unit_equations.py +0 -0
  80. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/output_collector.py +0 -0
  81. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/pathsim/__init__.py +0 -0
  82. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/pathsim/adapter.py +0 -0
  83. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/pcl/__init__.py +0 -0
  84. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/pcl/compiler.py +0 -0
  85. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/pcl/namespace.py +0 -0
  86. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/persistence/__init__.py +0 -0
  87. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/provenance.py +0 -0
  88. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/__init__.py +0 -0
  89. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/_sim_strategy.py +0 -0
  90. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/base.py +0 -0
  91. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/base_jacobian_mixin.py +0 -0
  92. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/base_simulation_provider.py +0 -0
  93. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/cantera_jacobian.py +0 -0
  94. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/cantera_provider.py +0 -0
  95. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/container_client.py +0 -0
  96. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/coolprop_provider.py +0 -0
  97. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/errors.py +0 -0
  98. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/festim/__init__.py +0 -0
  99. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/festim/build_helpers.py +0 -0
  100. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/festim/provider.py +0 -0
  101. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/festim/result_extraction.py +0 -0
  102. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/festim/strategies.py +0 -0
  103. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/jacobian_contributor.py +0 -0
  104. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/manager.py +0 -0
  105. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/modelica_jacobian.py +0 -0
  106. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/modelica_provider.py +0 -0
  107. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/openmc/__init__.py +0 -0
  108. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/openmc/build_helpers.py +0 -0
  109. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/openmc/provider.py +0 -0
  110. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/openmc/result_extraction.py +0 -0
  111. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/openmc/strategies.py +0 -0
  112. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/reference_state_registry.py +0 -0
  113. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/providers/registry.py +0 -0
  114. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/quantity.py +0 -0
  115. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/result_schema.py +0 -0
  116. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/schemas/__init__.py +0 -0
  117. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/schemas/festim/festim_model.py +0 -0
  118. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/schemas/flowsheet_schema.json +0 -0
  119. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/schemas/openmc/openmc_model.py +0 -0
  120. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/simulate.py +0 -0
  121. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/solver.py +0 -0
  122. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/state.py +0 -0
  123. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/thermo.py +0 -0
  124. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/types.py +0 -0
  125. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/__init__.py +0 -0
  126. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/base.py +0 -0
  127. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/cstr.py +0 -0
  128. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/flash.py +0 -0
  129. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/heater.py +0 -0
  130. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/pfr.py +0 -0
  131. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/pipes.py +0 -0
  132. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/pump.py +0 -0
  133. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/registry.py +0 -0
  134. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/solver_unit.py +0 -0
  135. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/strainer.py +0 -0
  136. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/tank.py +0 -0
  137. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/units/valve.py +0 -0
  138. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/utils/__init__.py +0 -0
  139. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/utils/flowsheet_diagram.py +0 -0
  140. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/utils/mermaid_diagram.py +0 -0
  141. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/utils/s3_upload.py +0 -0
  142. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/utils/topology.py +0 -0
  143. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/utils/unit_consistency.py +0 -0
  144. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/utils/validate_flowsheet.py +0 -0
  145. {processforge-0.5.1 → processforge-0.6.2}/src/processforge/utils/validation.py +0 -0
  146. {processforge-0.5.1 → processforge-0.6.2}/src/processforge.egg-info/dependency_links.txt +0 -0
  147. {processforge-0.5.1 → processforge-0.6.2}/src/processforge.egg-info/entry_points.txt +0 -0
  148. {processforge-0.5.1 → processforge-0.6.2}/src/processforge.egg-info/requires.txt +0 -0
  149. {processforge-0.5.1 → processforge-0.6.2}/src/processforge.egg-info/top_level.txt +0 -0
  150. {processforge-0.5.1 → processforge-0.6.2}/tests/test_container_client.py +0 -0
  151. {processforge-0.5.1 → processforge-0.6.2}/tests/test_coupling.py +0 -0
  152. {processforge-0.5.1 → processforge-0.6.2}/tests/test_display.py +0 -0
  153. {processforge-0.5.1 → processforge-0.6.2}/tests/test_festim_provider.py +0 -0
  154. {processforge-0.5.1 → processforge-0.6.2}/tests/test_festim_schema.py +0 -0
  155. {processforge-0.5.1 → processforge-0.6.2}/tests/test_fmu_solverunit.py +0 -0
  156. {processforge-0.5.1 → processforge-0.6.2}/tests/test_init.py +0 -0
  157. {processforge-0.5.1 → processforge-0.6.2}/tests/test_openmc_provider.py +0 -0
  158. {processforge-0.5.1 → processforge-0.6.2}/tests/test_pathsim_adapter.py +0 -0
  159. {processforge-0.5.1 → processforge-0.6.2}/tests/test_persist.py +0 -0
  160. {processforge-0.5.1 → processforge-0.6.2}/tests/test_provider_errors.py +0 -0
  161. {processforge-0.5.1 → processforge-0.6.2}/tests/test_providers.py +0 -0
  162. {processforge-0.5.1 → processforge-0.6.2}/tests/test_result_zarr.py +0 -0
  163. {processforge-0.5.1 → processforge-0.6.2}/tests/test_s3_upload.py +0 -0
  164. {processforge-0.5.1 → processforge-0.6.2}/tests/test_state.py +0 -0
  165. {processforge-0.5.1 → processforge-0.6.2}/tests/test_types.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: processforge
3
- Version: 0.5.1
3
+ Version: 0.6.2
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
@@ -134,13 +134,30 @@ uv tool install "processforge[modelica]"
134
134
 
135
135
  ## Python API
136
136
 
137
+ ### Low-level API
138
+
137
139
  ```python
138
140
  from processforge import EOFlowsheet, validate_flowsheet
141
+
139
142
  config = validate_flowsheet("flowsheets/hydraulic-chain.json")
140
143
  fs = EOFlowsheet(config, backend="scipy")
141
144
  results = fs.run()
142
145
  ```
143
146
 
147
+ ### High-level runner (web-app friendly)
148
+
149
+ ```python
150
+ from processforge import run_flowsheet
151
+
152
+ result = run_flowsheet("flowsheets/hydraulic-chain.json")
153
+ print(result.run_id, result.status, result.remote_uris)
154
+ ```
155
+
156
+ `run_flowsheet` and `apply_flowsheet` perform the full CLI lifecycle
157
+ (validate, health-check, solve, persist, and upload the pfarchive to S3) and
158
+ return structured results instead of calling `SystemExit`. See
159
+ [docs/usage.md](docs/usage.md) for a FastAPI + S3/Railway example.
160
+
144
161
  ## Usage
145
162
  See the [usage guide](docs/usage.md) for CLI commands and workflows.
146
163
 
@@ -67,13 +67,30 @@ uv tool install "processforge[modelica]"
67
67
 
68
68
  ## Python API
69
69
 
70
+ ### Low-level API
71
+
70
72
  ```python
71
73
  from processforge import EOFlowsheet, validate_flowsheet
74
+
72
75
  config = validate_flowsheet("flowsheets/hydraulic-chain.json")
73
76
  fs = EOFlowsheet(config, backend="scipy")
74
77
  results = fs.run()
75
78
  ```
76
79
 
80
+ ### High-level runner (web-app friendly)
81
+
82
+ ```python
83
+ from processforge import run_flowsheet
84
+
85
+ result = run_flowsheet("flowsheets/hydraulic-chain.json")
86
+ print(result.run_id, result.status, result.remote_uris)
87
+ ```
88
+
89
+ `run_flowsheet` and `apply_flowsheet` perform the full CLI lifecycle
90
+ (validate, health-check, solve, persist, and upload the pfarchive to S3) and
91
+ return structured results instead of calling `SystemExit`. See
92
+ [docs/usage.md](docs/usage.md) for a FastAPI + S3/Railway example.
93
+
77
94
  ## Usage
78
95
  See the [usage guide](docs/usage.md) for CLI commands and workflows.
79
96
 
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "processforge"
7
- version = "0.5.1"
7
+ version = "0.6.2"
8
8
  description = "A Python-based process simulation framework for chemical engineering applications."
9
9
  readme = "README.md"
10
10
  license = "BSD-3-Clause"
@@ -10,46 +10,66 @@ 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.2"
14
+
15
+ from .eo import EOFlowsheet, EOSolver
13
16
  from .flowsheet import Flowsheet
14
17
  from .provenance import build_run_info
15
- from .solver import Solver
16
- from .thermo import rachford_rice
17
- from .utils.validate_flowsheet import validate_flowsheet
18
18
  from .result import (
19
19
  plot_results,
20
20
  plot_timeseries,
21
- relink_latest_results,
22
21
  save_results_zarr,
23
22
  )
23
+ from .runner import (
24
+ ApplyResult,
25
+ ConvergenceError,
26
+ FlowsheetValidationError,
27
+ ProcessforgeRunError,
28
+ ProviderRunError,
29
+ ProviderUnavailableError,
30
+ RunResult,
31
+ StatePersistenceError,
32
+ apply_flowsheet,
33
+ run_flowsheet,
34
+ )
35
+ from .solver import Solver
36
+ from .thermo import rachford_rice
37
+ from .units.flash import Flash
38
+ from .units.heater import Heater
39
+ from .units.pipes import Pipes
24
40
  from .units.pump import Pump
25
- from .units.valve import Valve
26
41
  from .units.strainer import Strainer
27
42
  from .units.tank import Tank
28
- from .units.pipes import Pipes
29
- from .units.flash import Flash
30
- from .units.heater import Heater
31
- from .eo import EOFlowsheet, EOSolver
32
-
33
- __version__ = "0.5.1"
43
+ from .units.valve import Valve
44
+ from .utils.validate_flowsheet import validate_flowsheet
34
45
 
35
46
  __all__ = [
36
- "Flowsheet",
47
+ "ApplyResult",
48
+ "ConvergenceError",
37
49
  "EOFlowsheet",
38
50
  "EOSolver",
39
- "Solver",
40
- "rachford_rice",
41
- "validate_flowsheet",
42
- "plot_results",
43
- "plot_timeseries",
44
- "save_results_zarr",
45
- "relink_latest_results",
46
- "build_run_info",
51
+ "Flash",
52
+ "Flowsheet",
53
+ "FlowsheetValidationError",
54
+ "Heater",
55
+ "Pipes",
56
+ "ProcessforgeRunError",
57
+ "ProviderRunError",
58
+ "ProviderUnavailableError",
47
59
  "Pump",
48
- "Valve",
60
+ "RunResult",
61
+ "Solver",
62
+ "StatePersistenceError",
49
63
  "Strainer",
50
64
  "Tank",
51
- "Pipes",
52
- "Flash",
53
- "Heater",
65
+ "Valve",
54
66
  "__version__",
67
+ "apply_flowsheet",
68
+ "build_run_info",
69
+ "plot_results",
70
+ "plot_timeseries",
71
+ "rachford_rice",
72
+ "run_flowsheet",
73
+ "save_results_zarr",
74
+ "validate_flowsheet",
55
75
  ]
@@ -0,0 +1,55 @@
1
+ """``pf apply`` — state-based warm start with homotopy fallback."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Literal
6
+
7
+ import typer
8
+ from loguru import logger
9
+
10
+ from ..runner import ProcessforgeRunError, apply_flowsheet
11
+
12
+
13
+ def apply(
14
+ flowsheet: str = typer.Argument(help="Path to the flowsheet JSON file"),
15
+ backend: Literal["scipy", "pyomo", "casadi"] | None = typer.Option(
16
+ None,
17
+ "--backend",
18
+ help="Override the flowsheet's simulation.backend",
19
+ ),
20
+ tolerance: float = typer.Option(
21
+ 1e-6,
22
+ "--tolerance",
23
+ help="Newton solver convergence tolerance (default: 1e-6)",
24
+ ),
25
+ max_iter: int = typer.Option(
26
+ 50,
27
+ "--max-iter",
28
+ help="Max Newton iterations (default: 50)",
29
+ ),
30
+ skip_homotopy: bool = typer.Option(
31
+ False,
32
+ "--skip-homotopy",
33
+ help="Disable homotopy fallback; cold-start only",
34
+ ),
35
+ ) -> None:
36
+ """Apply flowsheet: drift detection, warm-start, homotopy fallback, convergence guardrails."""
37
+ try:
38
+ result = apply_flowsheet(
39
+ flowsheet,
40
+ backend=backend,
41
+ tolerance=tolerance,
42
+ max_iter=max_iter,
43
+ skip_homotopy=skip_homotopy,
44
+ )
45
+ except ProcessforgeRunError as exc:
46
+ logger.error(str(exc))
47
+ raise SystemExit(1) from exc
48
+
49
+ logger.info("=== Apply Summary ===")
50
+ logger.info(f" Status : {result.status}")
51
+ logger.info(f" Run ID : {result.run_id}")
52
+ logger.info(f" Snapshot ID : {result.snapshot_id}")
53
+ logger.info(f" Archive : {result.archive_path}")
54
+ if result.remote_uris:
55
+ logger.info(f" Remote URIs : {len(result.remote_uris)} object(s) in S3")
@@ -77,13 +77,11 @@ def persist_run(
77
77
  if snapshot_id is not None:
78
78
  manifest.snapshot_id = snapshot_id
79
79
 
80
- stream_results = {k: v for k, v in results.items() if not hasattr(v, "fields")}
81
- archive.save_run(manifest, stream_results=stream_results)
80
+ archive.save_run(manifest)
82
81
 
83
- # Always persist a Zarr copy of the standardized outputs (fields + artifacts)
84
- # inside the archive, mirroring `pf run`.
82
+ # Persist Zarr store (single source of truth for stream timeseries).
85
83
  try:
86
- from ..result import relink_latest_results, save_results_zarr
84
+ from ..result import save_results_zarr
87
85
 
88
86
  run_results_dir = os.path.join(archive.path, "results", run_id)
89
87
  save_results_zarr(
@@ -91,7 +89,6 @@ def persist_run(
91
89
  os.path.join(run_results_dir, "results.zarr"),
92
90
  run_info,
93
91
  )
94
- relink_latest_results(archive.path, run_id)
95
92
  except Exception as e:
96
93
  logger.warning(f"Failed to write results.zarr: {type(e).__name__}: {e}")
97
94
 
@@ -0,0 +1,30 @@
1
+ """``pf run`` — run a process simulation from a flowsheet JSON file."""
2
+ from __future__ import annotations
3
+
4
+ import typer
5
+ from loguru import logger
6
+
7
+ from ..runner import ProcessforgeRunError, run_flowsheet
8
+
9
+
10
+ def run(
11
+ flowsheet: str = typer.Argument(help="Path to the flowsheet JSON file"),
12
+ export_images: bool = typer.Option(
13
+ False,
14
+ "--export-images",
15
+ help="Generate PNG plots for simulation outputs",
16
+ ),
17
+ ) -> None:
18
+ """Run a process simulation from a flowsheet JSON file."""
19
+ try:
20
+ result = run_flowsheet(flowsheet, export_images=export_images)
21
+ except ProcessforgeRunError as exc:
22
+ logger.error(str(exc))
23
+ raise SystemExit(1) from exc
24
+
25
+ logger.info("=== Run Summary ===")
26
+ logger.info(f" Status : {result.status}")
27
+ logger.info(f" Run ID : {result.run_id}")
28
+ logger.info(f" Archive : {result.archive_path}")
29
+ if result.remote_uris:
30
+ logger.info(f" Remote URIs : {len(result.remote_uris)} object(s) in S3")
@@ -8,28 +8,20 @@ A ``<base>.pfarchive`` directory holds, in one place:
8
8
  * ``runs/<run_id>.json`` — a :class:`~processforge.types.RunManifest` capturing
9
9
  every engine output (OpenMC, FESTIM, CoolProp, Cantera) for one ``pf run`` /
10
10
  ``pf apply``.
11
- * ``outputs/streams/`` — stream timeseries from the flowsheet solve.
12
- * ``artifacts.json`` — content-addressed registry of every
13
- :class:`~processforge.types.OutputArtifact` (local + remote URIs).
14
- * ``index.json`` — ``field_name -> [occurrences]`` for fast cross-run
15
- queries.
11
+ * ``results/<run_id>/results.zarr`` — stream timeseries and engine outputs
12
+ in a compressed Zarr store (the single source of truth for time-series data).
16
13
  * ``latest_run`` — pointer to the most recent run.
17
-
18
- This replaces the old split of ``.pfstate`` (state only) + ``_results.zarr``
19
- (stream results) + loose ``run_dir`` files.
20
14
  """
21
15
  from __future__ import annotations
22
16
 
23
17
  import json
24
18
  import os
25
- from datetime import datetime, timezone
26
19
  from typing import Optional
27
20
 
28
- import zarr
29
21
  from loguru import logger
30
22
 
31
23
  from ..state import StateManager
32
- from ..types import OutputArtifact, RunManifest, SnapshotState
24
+ from ..types import RunManifest, SnapshotState
33
25
 
34
26
 
35
27
  def _read_json(path: str, default):
@@ -51,7 +43,6 @@ class ProcessStateArchive:
51
43
  def __init__(self, path: str) -> None:
52
44
  self.path = path
53
45
  os.makedirs(self.path, exist_ok=True)
54
- # Snapshots live inside the same archive, via the proven StateManager.
55
46
  self._state = StateManager(self.path)
56
47
 
57
48
  # ==================================================================
@@ -90,44 +81,12 @@ class ProcessStateArchive:
90
81
  def _runs_dir(self) -> str:
91
82
  return os.path.join(self.path, "runs")
92
83
 
93
- def _outputs_dir(self) -> str:
94
- return os.path.join(self.path, "outputs", "streams")
95
-
96
- def save_run(self, manifest: RunManifest, stream_results: Optional[dict] = None) -> str:
97
- """Persist a :class:`RunManifest` (and optional stream timeseries)."""
84
+ def save_run(self, manifest: RunManifest) -> str:
85
+ """Persist a :class:`RunManifest` to disk."""
98
86
  os.makedirs(self._runs_dir(), exist_ok=True)
99
87
  run_path = os.path.join(self._runs_dir(), f"{manifest.run_id}.json")
100
88
  _write_json(run_path, json.loads(manifest.model_dump_json()))
101
89
 
102
- # Stream timeseries (kept for plotting / downstream consumers).
103
- if stream_results:
104
- for name, data in stream_results.items():
105
- if isinstance(data, dict):
106
- _write_json(os.path.join(self._outputs_dir(), f"{name}.json"), data)
107
-
108
- # Artifact registry (append-only, keyed by artifact_id).
109
- registry = _read_json(os.path.join(self.path, "artifacts.json"), {})
110
- for out in list(manifest.units.values()) + list(manifest.streams.values()):
111
- for art in getattr(out, "artifacts", []):
112
- registry[art.artifact_id] = art.model_dump()
113
- _write_json(os.path.join(self.path, "artifacts.json"), registry)
114
-
115
- # Field index for fast lookup.
116
- index = _read_json(os.path.join(self.path, "index.json"), {})
117
- for unit_name, out in manifest.units.items():
118
- for f in out.fields:
119
- index.setdefault(f.name, []).append({
120
- "run_id": manifest.run_id, "scope": "unit", "name": unit_name,
121
- "engine": out.engine, "units": f.quantity.unit,
122
- })
123
- for stream_name, out in manifest.streams.items():
124
- for f in out.fields:
125
- index.setdefault(f.name, []).append({
126
- "run_id": manifest.run_id, "scope": "stream", "name": stream_name,
127
- "engine": out.engine, "units": f.quantity.unit,
128
- })
129
- _write_json(os.path.join(self.path, "index.json"), index)
130
-
131
90
  with open(os.path.join(self.path, "latest_run"), "w", encoding="utf-8") as f:
132
91
  f.write(manifest.run_id)
133
92
 
@@ -159,8 +118,32 @@ class ProcessStateArchive:
159
118
  )
160
119
 
161
120
  def field_occurrences(self, field_name: str) -> list[dict]:
162
- index = _read_json(os.path.join(self.path, "index.json"), {})
163
- return index.get(field_name, [])
164
-
165
- def list_artifacts(self) -> dict[str, dict]:
166
- return _read_json(os.path.join(self.path, "artifacts.json"), {})
121
+ """Scan ``runs/*.json`` for fields matching *field_name*."""
122
+ results: list[dict] = []
123
+ runs_dir = self._runs_dir()
124
+ if not os.path.isdir(runs_dir):
125
+ return results
126
+ for fname in sorted(os.listdir(runs_dir)):
127
+ if not fname.endswith(".json"):
128
+ continue
129
+ run_id = fname.replace(".json", "")
130
+ manifest = self.load_run(run_id)
131
+ if manifest is None:
132
+ continue
133
+ for unit_name, out in manifest.units.items():
134
+ for f in out.fields:
135
+ if f.name == field_name:
136
+ results.append({
137
+ "run_id": run_id, "scope": "unit",
138
+ "name": unit_name, "engine": out.engine,
139
+ "units": f.quantity.unit,
140
+ })
141
+ for stream_name, out in manifest.streams.items():
142
+ for f in out.fields:
143
+ if f.name == field_name:
144
+ results.append({
145
+ "run_id": run_id, "scope": "stream",
146
+ "name": stream_name, "engine": out.engine,
147
+ "units": f.quantity.unit,
148
+ })
149
+ return results
@@ -10,8 +10,6 @@ from __future__ import annotations
10
10
 
11
11
  import hashlib
12
12
  import os
13
- from datetime import datetime, timezone
14
- from typing import Optional
15
13
 
16
14
  from loguru import logger
17
15
 
@@ -44,9 +42,9 @@ def _artifact_kind(path: str) -> str:
44
42
  class ArtifactStore:
45
43
  """Register and upload simulation artifact files to object storage."""
46
44
 
47
- def __init__(self, bucket: Optional[str] = None, prefix: str = "processforge"):
45
+ def __init__(self, bucket: str | None = None, prefix: str | None = None):
48
46
  self.bucket = bucket or os.environ.get("S3_BUCKET")
49
- self.prefix = prefix
47
+ self.prefix = prefix or os.environ.get("S3_PREFIX", "processforge")
50
48
 
51
49
  # ------------------------------------------------------------------
52
50
  # Registration
@@ -55,8 +53,8 @@ class ArtifactStore:
55
53
  self,
56
54
  path: str,
57
55
  *,
58
- name: Optional[str] = None,
59
- kind: Optional[str] = None,
56
+ name: str | None = None,
57
+ kind: str | None = None,
60
58
  run_id: str = "",
61
59
  flowsheet_hash: str = "",
62
60
  unit: str = "",
@@ -115,6 +113,96 @@ class ArtifactStore:
115
113
  logger.warning(f"S3 upload of '{artifact.name}' failed: {exc}")
116
114
  return artifact
117
115
 
116
+ # ------------------------------------------------------------------
117
+ # Host-side archive upload
118
+ # ------------------------------------------------------------------
119
+ def upload_file(
120
+ self,
121
+ path: str,
122
+ *,
123
+ remote_key: str,
124
+ ) -> str | None:
125
+ """Upload a single local file to a specific S3 key.
126
+
127
+ Returns the S3 URI on success, or ``None`` when S3 is not configured or
128
+ the upload failed.
129
+ """
130
+ if not self.bucket or not os.path.exists(path):
131
+ return None
132
+ try:
133
+ import s3fs
134
+
135
+ uri = f"s3://{self.bucket}/{remote_key}"
136
+ fs = s3fs.S3FileSystem(**s3_storage_options())
137
+ fs.put(path, uri)
138
+ logger.info(f"Uploaded file '{os.path.basename(path)}' to {uri}")
139
+ return uri
140
+ except Exception as exc: # noqa: BLE001
141
+ logger.warning(f"S3 upload of '{path}' failed: {exc}")
142
+ return None
143
+
144
+ def upload_directory(
145
+ self,
146
+ local_dir: str,
147
+ *,
148
+ key_prefix: str,
149
+ run_id: str = "",
150
+ flowsheet_hash: str = "",
151
+ ) -> list[str]:
152
+ """Recursively upload a local directory to S3 under *key_prefix*.
153
+
154
+ Relative paths inside *local_dir* are preserved in the S3 keys. Returns
155
+ the list of URIs that were uploaded (or an empty list when S3 is
156
+ disabled).
157
+ """
158
+ if not self.bucket or not os.path.isdir(local_dir):
159
+ return []
160
+
161
+ base_key = "/".join(p for p in [self.prefix, flowsheet_hash, run_id, key_prefix] if p)
162
+ try:
163
+ import s3fs
164
+
165
+ fs = s3fs.S3FileSystem(**s3_storage_options())
166
+ except Exception as exc: # noqa: BLE001
167
+ logger.warning(f"S3 upload of directory '{local_dir}' failed: {exc}")
168
+ return []
169
+
170
+ uris: list[str] = []
171
+ for root, _dirs, files in os.walk(local_dir):
172
+ for name in files:
173
+ local_path = os.path.join(root, name)
174
+ rel = os.path.relpath(local_path, local_dir)
175
+ key = f"{base_key}/{rel}"
176
+ uri = f"s3://{self.bucket}/{key}"
177
+ try:
178
+ fs.put(local_path, uri)
179
+ uris.append(uri)
180
+ except Exception as exc: # noqa: BLE001
181
+ logger.warning(f"S3 upload of '{rel}' failed: {exc}")
182
+ logger.info(f"Uploaded directory '{local_dir}' to {len(uris)} S3 object(s)")
183
+ return uris
184
+
185
+ def persist_archive(
186
+ self,
187
+ archive_path: str,
188
+ *,
189
+ run_id: str = "",
190
+ flowsheet_hash: str = "",
191
+ ) -> list[str]:
192
+ """Upload an entire processforge pfarchive directory to S3.
193
+
194
+ Keys are laid out as ``<prefix>/<flowsheet_hash>/<run_id>/archive/<relpath>``.
195
+ This uploads the run manifest, Zarr results, snapshots, and registry
196
+ files from the host process so they are durable even when the host's
197
+ local disk is ephemeral.
198
+ """
199
+ return self.upload_directory(
200
+ archive_path,
201
+ key_prefix="archive",
202
+ run_id=run_id,
203
+ flowsheet_hash=flowsheet_hash,
204
+ )
205
+
118
206
  # ------------------------------------------------------------------
119
207
  # Container-side convenience: persist all artifacts in engine outputs
120
208
  # ------------------------------------------------------------------
@@ -291,34 +291,6 @@ def save_results_zarr(
291
291
  return store_path
292
292
 
293
293
 
294
- def relink_latest_results(archive_path: str, run_id: str) -> None:
295
- """Point ``<archive>/results.zarr`` at the latest per-run zarr.
296
-
297
- Each run now writes its zarr to ``<archive>/results/<run_id>/results.zarr``
298
- (see `save_results_zarr`). To keep backward compatibility with tooling that
299
- reads a single ``results.zarr`` at the archive root, we make that path a
300
- symlink to the newest run. Falls back to a copy on platforms/filesystems
301
- without symlink support (or when the existing target is a real directory).
302
- """
303
- latest = os.path.join(archive_path, "results", run_id, "results.zarr")
304
- if not os.path.exists(latest):
305
- return
306
- link_path = os.path.join(archive_path, "results.zarr")
307
-
308
- # Remove any existing target (real dir or stale/broken symlink) without
309
- # following the link.
310
- if os.path.islink(link_path):
311
- os.unlink(link_path)
312
- elif os.path.exists(link_path):
313
- shutil.rmtree(link_path)
314
-
315
- try:
316
- os.symlink(latest, link_path)
317
- except (OSError, NotImplementedError):
318
- # Non-POSIX / restricted filesystem: keep a physical copy instead.
319
- shutil.copytree(latest, link_path)
320
-
321
-
322
294
  def save_results_zarr_s3(results, s3_uri: str, run_info: RunInfo | dict | None = None):
323
295
  """Write simulation results directly to an S3-backed Zarr store.
324
296