processforge 0.6.8__tar.gz → 0.7.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 (183) hide show
  1. {processforge-0.6.8/src/processforge.egg-info → processforge-0.7.0}/PKG-INFO +2 -1
  2. processforge-0.7.0/flowsheets/custom/crimson/simple_water_system_modified_b.json +122 -0
  3. {processforge-0.6.8 → processforge-0.7.0}/pyproject.toml +2 -1
  4. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/__init__.py +1 -1
  5. processforge-0.7.0/src/processforge/cae/__init__.py +49 -0
  6. processforge-0.7.0/src/processforge/cae/evidence.py +310 -0
  7. processforge-0.7.0/src/processforge/cae/file_repository.py +155 -0
  8. processforge-0.7.0/src/processforge/cae/loader.py +144 -0
  9. processforge-0.7.0/src/processforge/cae/reporting/__init__.py +5 -0
  10. processforge-0.7.0/src/processforge/cae/reporting/cae_renderer.py +160 -0
  11. processforge-0.7.0/src/processforge/cae/repository.py +33 -0
  12. processforge-0.7.0/src/processforge/cae/service.py +118 -0
  13. processforge-0.7.0/src/processforge/cae/types.py +211 -0
  14. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/__init__.py +4 -1
  15. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/runs.py +85 -0
  16. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/validate_flowsheet.py +56 -15
  17. {processforge-0.6.8 → processforge-0.7.0/src/processforge.egg-info}/PKG-INFO +2 -1
  18. {processforge-0.6.8 → processforge-0.7.0}/src/processforge.egg-info/SOURCES.txt +13 -1
  19. {processforge-0.6.8 → processforge-0.7.0}/src/processforge.egg-info/requires.txt +1 -0
  20. processforge-0.7.0/tests/test_cae.py +435 -0
  21. processforge-0.7.0/tests/test_validate_flowsheet.py +93 -0
  22. {processforge-0.6.8 → processforge-0.7.0}/LICENSE +0 -0
  23. {processforge-0.6.8 → processforge-0.7.0}/MANIFEST.in +0 -0
  24. {processforge-0.6.8 → processforge-0.7.0}/README.md +0 -0
  25. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/closed-loop-chain.json +0 -0
  26. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/coupled/msre_coupled.json +0 -0
  27. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/custom/crimson/MUWS_HB.json +0 -0
  28. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/custom/crimson/simple_water_system.json +0 -0
  29. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/custom/crimson/simple_water_system_modified.json +0 -0
  30. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/custom/simple_hyrdaulic_scheme.json +0 -0
  31. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/festim/hydrogen_transport_1d.json +0 -0
  32. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/festim/tds_tungsten.json +0 -0
  33. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/hydraulic-chain.json +0 -0
  34. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/idaes/closed-loop-chain-idaes.json +0 -0
  35. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/idaes/hydraulic-chain-idaes.json +0 -0
  36. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/idaes/hydraulic-chain-mixed.json +0 -0
  37. {processforge-0.6.8 → processforge-0.7.0}/flowsheets/openmc/msre_eigenvalue.json +0 -0
  38. {processforge-0.6.8 → processforge-0.7.0}/setup.cfg +0 -0
  39. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/__main__.py +0 -0
  40. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/_schema.py +0 -0
  41. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/analysis/__init__.py +0 -0
  42. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/analysis/dof.py +0 -0
  43. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/api/__init__.py +0 -0
  44. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/api/serve.py +0 -0
  45. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/apply.py +0 -0
  46. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/common.py +0 -0
  47. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/diagram.py +0 -0
  48. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/display.py +0 -0
  49. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/export_fmu.py +0 -0
  50. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/export_modelica.py +0 -0
  51. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/init.py +0 -0
  52. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/persist.py +0 -0
  53. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/plan.py +0 -0
  54. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/run.py +0 -0
  55. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/cli/validate.py +0 -0
  56. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/compose.py +0 -0
  57. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/coupling.py +0 -0
  58. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/__init__.py +0 -0
  59. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/backends/__init__.py +0 -0
  60. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/backends/base.py +0 -0
  61. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/backends/casadi_backend.py +0 -0
  62. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/backends/pyomo_backend.py +0 -0
  63. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/backends/scipy_backend.py +0 -0
  64. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/flowsheet.py +0 -0
  65. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/jacobian.py +0 -0
  66. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/mixin.py +0 -0
  67. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/solver.py +0 -0
  68. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/stream_var.py +0 -0
  69. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/units/__init__.py +0 -0
  70. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/units/flash_eo.py +0 -0
  71. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/units/heater_eo.py +0 -0
  72. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/units/pipes_eo.py +0 -0
  73. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/units/pump_eo.py +0 -0
  74. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/units/strainer_eo.py +0 -0
  75. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/eo/units/valve_eo.py +0 -0
  76. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/flowsheet.py +0 -0
  77. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/fmu/__init__.py +0 -0
  78. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/fmu/_fmi_vars.py +0 -0
  79. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/fmu/builder.py +0 -0
  80. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/fmu/interface.py +0 -0
  81. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/fmu/slave_template.py +0 -0
  82. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/lock.py +0 -0
  83. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/modelica/__init__.py +0 -0
  84. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/modelica/mo_writer.py +0 -0
  85. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/modelica/omc_runner.py +0 -0
  86. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/modelica/transpiler.py +0 -0
  87. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/modelica/unit_equations.py +0 -0
  88. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/output_collector.py +0 -0
  89. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/pathsim/__init__.py +0 -0
  90. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/pathsim/adapter.py +0 -0
  91. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/pcl/__init__.py +0 -0
  92. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/pcl/compiler.py +0 -0
  93. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/pcl/namespace.py +0 -0
  94. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/persistence/__init__.py +0 -0
  95. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/persistence/archive.py +0 -0
  96. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/persistence/artifact_store.py +0 -0
  97. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/provenance.py +0 -0
  98. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/__init__.py +0 -0
  99. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/_sim_strategy.py +0 -0
  100. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/base.py +0 -0
  101. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/base_jacobian_mixin.py +0 -0
  102. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/base_simulation_provider.py +0 -0
  103. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/cantera_jacobian.py +0 -0
  104. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/cantera_provider.py +0 -0
  105. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/container_client.py +0 -0
  106. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/coolprop_provider.py +0 -0
  107. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/errors.py +0 -0
  108. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/festim/__init__.py +0 -0
  109. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/festim/build_helpers.py +0 -0
  110. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/festim/provider.py +0 -0
  111. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/festim/result_extraction.py +0 -0
  112. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/festim/strategies.py +0 -0
  113. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/idaes_provider.py +0 -0
  114. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/jacobian_contributor.py +0 -0
  115. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/manager.py +0 -0
  116. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/modelica_jacobian.py +0 -0
  117. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/modelica_provider.py +0 -0
  118. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/openmc/__init__.py +0 -0
  119. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/openmc/build_helpers.py +0 -0
  120. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/openmc/provider.py +0 -0
  121. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/openmc/result_extraction.py +0 -0
  122. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/openmc/strategies.py +0 -0
  123. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/reference_state_registry.py +0 -0
  124. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/providers/registry.py +0 -0
  125. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/quantity.py +0 -0
  126. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/result.py +0 -0
  127. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/result_schema.py +0 -0
  128. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/runner.py +0 -0
  129. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/schemas/__init__.py +0 -0
  130. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/schemas/festim/festim_model.py +0 -0
  131. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/schemas/flowsheet_schema.json +0 -0
  132. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/schemas/openmc/openmc_model.py +0 -0
  133. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/simulate.py +0 -0
  134. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/solver.py +0 -0
  135. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/state.py +0 -0
  136. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/thermo.py +0 -0
  137. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/types.py +0 -0
  138. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/__init__.py +0 -0
  139. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/base.py +0 -0
  140. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/cstr.py +0 -0
  141. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/flash.py +0 -0
  142. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/heater.py +0 -0
  143. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/pfr.py +0 -0
  144. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/pipes.py +0 -0
  145. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/pump.py +0 -0
  146. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/registry.py +0 -0
  147. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/solver_unit.py +0 -0
  148. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/strainer.py +0 -0
  149. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/tank.py +0 -0
  150. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/units/valve.py +0 -0
  151. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/__init__.py +0 -0
  152. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/flowsheet_diagram.py +0 -0
  153. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/mermaid_diagram.py +0 -0
  154. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/plotting.py +0 -0
  155. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/s3_upload.py +0 -0
  156. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/topology.py +0 -0
  157. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/unit_consistency.py +0 -0
  158. {processforge-0.6.8 → processforge-0.7.0}/src/processforge/utils/validation.py +0 -0
  159. {processforge-0.6.8 → processforge-0.7.0}/src/processforge.egg-info/dependency_links.txt +0 -0
  160. {processforge-0.6.8 → processforge-0.7.0}/src/processforge.egg-info/entry_points.txt +0 -0
  161. {processforge-0.6.8 → processforge-0.7.0}/src/processforge.egg-info/top_level.txt +0 -0
  162. {processforge-0.6.8 → processforge-0.7.0}/tests/test_artifact_store.py +0 -0
  163. {processforge-0.6.8 → processforge-0.7.0}/tests/test_cli.py +0 -0
  164. {processforge-0.6.8 → processforge-0.7.0}/tests/test_container_client.py +0 -0
  165. {processforge-0.6.8 → processforge-0.7.0}/tests/test_coupling.py +0 -0
  166. {processforge-0.6.8 → processforge-0.7.0}/tests/test_display.py +0 -0
  167. {processforge-0.6.8 → processforge-0.7.0}/tests/test_dynamic_engine_outputs.py +0 -0
  168. {processforge-0.6.8 → processforge-0.7.0}/tests/test_festim_provider.py +0 -0
  169. {processforge-0.6.8 → processforge-0.7.0}/tests/test_festim_schema.py +0 -0
  170. {processforge-0.6.8 → processforge-0.7.0}/tests/test_fmu_solverunit.py +0 -0
  171. {processforge-0.6.8 → processforge-0.7.0}/tests/test_idaes_provider.py +0 -0
  172. {processforge-0.6.8 → processforge-0.7.0}/tests/test_init.py +0 -0
  173. {processforge-0.6.8 → processforge-0.7.0}/tests/test_openmc_provider.py +0 -0
  174. {processforge-0.6.8 → processforge-0.7.0}/tests/test_pathsim_adapter.py +0 -0
  175. {processforge-0.6.8 → processforge-0.7.0}/tests/test_persist.py +0 -0
  176. {processforge-0.6.8 → processforge-0.7.0}/tests/test_provider_errors.py +0 -0
  177. {processforge-0.6.8 → processforge-0.7.0}/tests/test_providers.py +0 -0
  178. {processforge-0.6.8 → processforge-0.7.0}/tests/test_result_zarr.py +0 -0
  179. {processforge-0.6.8 → processforge-0.7.0}/tests/test_runner.py +0 -0
  180. {processforge-0.6.8 → processforge-0.7.0}/tests/test_runs_command.py +0 -0
  181. {processforge-0.6.8 → processforge-0.7.0}/tests/test_s3_upload.py +0 -0
  182. {processforge-0.6.8 → processforge-0.7.0}/tests/test_state.py +0 -0
  183. {processforge-0.6.8 → processforge-0.7.0}/tests/test_types.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: processforge
3
- Version: 0.6.8
3
+ Version: 0.7.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
@@ -32,6 +32,7 @@ Requires-Dist: pint<1.0,>=0.24
32
32
  Requires-Dist: coolprop>=7.2.0
33
33
  Requires-Dist: typer>=0.12
34
34
  Requires-Dist: arrow>=1.3
35
+ Requires-Dist: pyyaml>=6.0
35
36
  Provides-Extra: api
36
37
  Requires-Dist: fastapi>=0.110; extra == "api"
37
38
  Requires-Dist: uvicorn>=0.29; extra == "api"
@@ -0,0 +1,122 @@
1
+ {
2
+ "metadata": {
3
+ "name": "Modified Water System A",
4
+ "description": "Closed-loop water system with gravity tank, pump, valves, and high-pressure tank.",
5
+ "version": "2.1"
6
+ },
7
+ "providers": {
8
+ "coolprop": {
9
+ "type": "coolprop"
10
+ }
11
+ },
12
+ "materials": {
13
+ "Water": {
14
+ "id": 1
15
+ },
16
+ "Steel": {
17
+ "id": 2
18
+ }
19
+ },
20
+ "streams": {},
21
+ "units": {
22
+ "tank_1": {
23
+ "type": "Tank",
24
+ "in": [
25
+ "after_pipe_5"
26
+ ],
27
+ "out": [
28
+ "tank_1_to_pipe1"
29
+ ],
30
+ "outlet_flow": 0.0005556,
31
+ "initial_n": {
32
+ "Water": 222000.0
33
+ },
34
+ "initial_T": 298.15,
35
+ "P": 101325,
36
+ "material": 1
37
+ },
38
+ "pipe_1": {
39
+ "type": "Pipes",
40
+ "in": "tank_1_to_pipe1",
41
+ "out": "after_pipe_1",
42
+ "delta_p": 1000.0,
43
+ "diameter": 0.05,
44
+ "material": 2
45
+ },
46
+ "low_pressure_pump": {
47
+ "type": "Pump",
48
+ "in": "after_pipe_1",
49
+ "out": "after_low_pressure_pump",
50
+ "material": 2,
51
+ "delta_p": 3000000.0
52
+ },
53
+ "pipe_2": {
54
+ "type": "Pipes",
55
+ "in": "after_low_pressure_pump",
56
+ "out": "after_pipe_2",
57
+ "delta_p": 1000.0,
58
+ "diameter": 0.05,
59
+ "material": 2
60
+ },
61
+ "makeup_valve_1": {
62
+ "type": "Valve",
63
+ "in": "after_pipe_2",
64
+ "out": "after_makeup_valve_1",
65
+ "material": 2,
66
+ "valve_type": "makeup",
67
+ "pressure_ratio": 0.5
68
+ },
69
+ "pipe_3": {
70
+ "type": "Pipes",
71
+ "in": "after_makeup_valve_1",
72
+ "out": "after_pipe_3",
73
+ "delta_p": 1000.0,
74
+ "diameter": 0.05,
75
+ "material": 2
76
+ },
77
+ "tank_2": {
78
+ "type": "Tank",
79
+ "in": [
80
+ "after_pipe_3"
81
+ ],
82
+ "out": "after_tank_2",
83
+ "outlet_flow": 0.00001111,
84
+ "initial_n": {
85
+ "Water": 555000.0
86
+ },
87
+ "initial_T": 298.15,
88
+ "P": 1961330,
89
+ "material": 1
90
+ },
91
+ "pipe_4": {
92
+ "type": "Pipes",
93
+ "in": "after_tank_2",
94
+ "out": "after_pipe_4",
95
+ "delta_p": 1000.0,
96
+ "diameter": 0.05,
97
+ "material": 2
98
+ },
99
+ "manual_bleed_valve": {
100
+ "type": "Valve",
101
+ "in": "after_pipe_4",
102
+ "out": "after_manual_bleed_valve",
103
+ "material": 2,
104
+ "pressure_ratio": 0.5
105
+ },
106
+ "pipe_5": {
107
+ "type": "Pipes",
108
+ "in": "after_manual_bleed_valve",
109
+ "out": "after_pipe_5",
110
+ "delta_p": 1000.0,
111
+ "diameter": 0.05,
112
+ "material": 2
113
+ }
114
+ },
115
+ "simulation": {
116
+ "mode": "dynamic",
117
+ "t0": 0.0,
118
+ "tf": 20.0,
119
+ "dt": 1.0,
120
+ "backend": "scipy"
121
+ }
122
+ }
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "processforge"
7
- version = "0.6.8"
7
+ version = "0.7.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"
@@ -38,6 +38,7 @@ dependencies = [
38
38
  "coolprop>=7.2.0",
39
39
  "typer>=0.12",
40
40
  "arrow>=1.3",
41
+ "pyyaml>=6.0",
41
42
  ]
42
43
 
43
44
  [project.optional-dependencies]
@@ -10,7 +10,7 @@ Provides steady-state and dynamic process simulation capabilities including:
10
10
  - Equation-oriented (EO) steady-state solver via EOFlowsheet
11
11
  """
12
12
 
13
- __version__ = "0.6.8"
13
+ __version__ = "0.7.0"
14
14
 
15
15
  from .eo import EOFlowsheet, EOSolver
16
16
  from .flowsheet import Flowsheet
@@ -0,0 +1,49 @@
1
+ """Claims, Arguments and Evidence (CAE) reporting.
2
+
3
+ CAE data lives outside the flowsheet schema and is linked to flowsheets through
4
+ ``cae/index.yaml``. Use :func:`generate_cae_reports` (or ``pf runs ... --cae``)
5
+ to render an assurance report for a concrete simulation run.
6
+ """
7
+
8
+ from .evidence import ResolvedEvidence, resolve_case_evidence
9
+ from .file_repository import FileCAERepository
10
+ from .loader import CAEError, find_cae_root, load_case, load_index
11
+ from .repository import CAERepository
12
+ from .service import CAEReport, generate_cae_reports
13
+ from .types import (
14
+ CAEArgument,
15
+ CAECase,
16
+ CAECaseLink,
17
+ CAECaseMeta,
18
+ CAECaseRef,
19
+ CAEClaim,
20
+ CAEEvidence,
21
+ CAEEvidenceRef,
22
+ CAEFlowsheetLink,
23
+ CAEIndex,
24
+ CAERequirement,
25
+ )
26
+
27
+ __all__ = [
28
+ "CAEArgument",
29
+ "CAECase",
30
+ "CAECaseLink",
31
+ "CAECaseMeta",
32
+ "CAECaseRef",
33
+ "CAEClaim",
34
+ "CAEError",
35
+ "CAEEvidence",
36
+ "CAEEvidenceRef",
37
+ "CAEFlowsheetLink",
38
+ "CAEIndex",
39
+ "CAEReport",
40
+ "CAERequirement",
41
+ "CAERepository",
42
+ "FileCAERepository",
43
+ "ResolvedEvidence",
44
+ "find_cae_root",
45
+ "generate_cae_reports",
46
+ "load_case",
47
+ "load_index",
48
+ "resolve_case_evidence",
49
+ ]
@@ -0,0 +1,310 @@
1
+ """Resolve CAE evidence references against a concrete simulation run.
2
+
3
+ Resolution is deliberately strict: every evidence item must point at an element
4
+ that exists in the flowsheet *and* at a value present in the run's Zarr results
5
+ (or manifest artifacts). A missing reference aborts the report rather than
6
+ silently emitting an unsupported claim.
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ import math
12
+ import os
13
+ from dataclasses import dataclass
14
+ from typing import Any, Iterable
15
+
16
+ from .loader import CAEError
17
+ from .types import CAECase, CAEEvidence, ExtractOp
18
+
19
+
20
+ @dataclass
21
+ class ResolvedEvidence:
22
+ """An evidence item paired with the value read from a run."""
23
+
24
+ evidence: CAEEvidence
25
+ value: Any
26
+ unit: str = ""
27
+ location: str = ""
28
+ run_id: str = ""
29
+ status: str = "resolved"
30
+
31
+
32
+ def flowsheet_elements(config: dict) -> tuple[set[str], set[str]]:
33
+ """Return the unit and stream names declared (or implied) by a flowsheet.
34
+
35
+ Streams are only sometimes listed explicitly; most appear as a unit's
36
+ ``in``/``out``/``inlets`` values, so those are collected too.
37
+ """
38
+ units = config.get("units", {}) or {}
39
+ unit_names = set(units) if isinstance(units, dict) else set()
40
+ stream_names: set[str] = set((config.get("streams", {}) or {}).keys())
41
+
42
+ for unit_cfg in units.values() if isinstance(units, dict) else []:
43
+ if not isinstance(unit_cfg, dict):
44
+ continue
45
+ for key in ("in", "out", "inlets"):
46
+ _collect_stream_names(unit_cfg.get(key), stream_names)
47
+ return unit_names, stream_names
48
+
49
+
50
+ def _collect_stream_names(value: Any, target: set[str]) -> None:
51
+ if isinstance(value, str):
52
+ target.add(value)
53
+ elif isinstance(value, dict):
54
+ for item in value.values():
55
+ _collect_stream_names(item, target)
56
+ elif isinstance(value, Iterable) and not isinstance(value, (bytes, bytearray)):
57
+ for item in value:
58
+ _collect_stream_names(item, target)
59
+
60
+
61
+ def resolve_case_evidence(
62
+ case: CAECase,
63
+ *,
64
+ flowsheet_config: dict,
65
+ run_summary: dict,
66
+ manifest: Any | None,
67
+ run_id: str,
68
+ zarr_path: str,
69
+ ) -> dict[str, ResolvedEvidence]:
70
+ """Resolve every evidence item in *case*, raising on the first failure.
71
+
72
+ All failures are collected and reported together so a single report run
73
+ surfaces every broken reference.
74
+ """
75
+ unit_names, stream_names = flowsheet_elements(flowsheet_config)
76
+ resolved: dict[str, ResolvedEvidence] = {}
77
+ errors: list[str] = []
78
+
79
+ for evidence in case.evidence:
80
+ try:
81
+ resolved[evidence.id] = _resolve_one(
82
+ evidence,
83
+ unit_names=unit_names,
84
+ stream_names=stream_names,
85
+ run_summary=run_summary,
86
+ manifest=manifest,
87
+ run_id=run_id,
88
+ zarr_path=zarr_path,
89
+ )
90
+ except CAEError as exc:
91
+ errors.append(f" - {evidence.id}: {exc}")
92
+
93
+ if errors:
94
+ raise CAEError(
95
+ "Cannot resolve CAE evidence for run "
96
+ f"'{run_id}':\n" + "\n".join(errors)
97
+ )
98
+ return resolved
99
+
100
+
101
+ def _resolve_one(
102
+ evidence: CAEEvidence,
103
+ *,
104
+ unit_names: set[str],
105
+ stream_names: set[str],
106
+ run_summary: dict,
107
+ manifest: Any | None,
108
+ run_id: str,
109
+ zarr_path: str,
110
+ ) -> ResolvedEvidence:
111
+ ref = evidence.ref
112
+
113
+ if ref.type == "unit":
114
+ return _resolve_unit(evidence, unit_names, run_summary, run_id, zarr_path)
115
+ if ref.type == "stream":
116
+ return _resolve_stream(evidence, stream_names, run_summary, run_id, zarr_path)
117
+ return _resolve_artifact(evidence, unit_names, manifest, run_id)
118
+
119
+
120
+ def _resolve_unit(
121
+ evidence: CAEEvidence,
122
+ unit_names: set[str],
123
+ run_summary: dict,
124
+ run_id: str,
125
+ zarr_path: str,
126
+ ) -> ResolvedEvidence:
127
+ ref = evidence.ref
128
+ if ref.name not in unit_names:
129
+ raise CAEError(
130
+ f"unit '{ref.name}' is not declared in the flowsheet "
131
+ f"(available: {_sorted(unit_names)})"
132
+ )
133
+
134
+ fields = _unit_fields(run_summary, ref.name)
135
+ if fields is None:
136
+ raise CAEError(
137
+ f"unit '{ref.name}' produced no engine output in run '{run_id}'"
138
+ )
139
+ field = _require_field(fields, ref.name, ref.field)
140
+ value, unit = _extract(field, ref.extract, f"unit '{ref.name}.{ref.field}'")
141
+ return ResolvedEvidence(
142
+ evidence=evidence,
143
+ value=value,
144
+ unit=unit,
145
+ location=zarr_path,
146
+ run_id=run_id,
147
+ )
148
+
149
+
150
+ def _resolve_stream(
151
+ evidence: CAEEvidence,
152
+ stream_names: set[str],
153
+ run_summary: dict,
154
+ run_id: str,
155
+ zarr_path: str,
156
+ ) -> ResolvedEvidence:
157
+ ref = evidence.ref
158
+ if ref.name not in stream_names:
159
+ raise CAEError(
160
+ f"stream '{ref.name}' is not declared or referenced in the flowsheet "
161
+ f"(available: {_sorted(stream_names)})"
162
+ )
163
+
164
+ stream = (run_summary.get("streams") or {}).get(ref.name)
165
+ if stream is None:
166
+ raise CAEError(f"stream '{ref.name}' produced no results in run '{run_id}'")
167
+ fields = stream.get("fields") or {}
168
+ field = _require_field(fields, f"stream '{ref.name}'", ref.field)
169
+ value, unit = _extract(field, ref.extract, f"stream '{ref.name}.{ref.field}'")
170
+ return ResolvedEvidence(
171
+ evidence=evidence,
172
+ value=value,
173
+ unit=unit,
174
+ location=zarr_path,
175
+ run_id=run_id,
176
+ )
177
+
178
+
179
+ def _resolve_artifact(
180
+ evidence: CAEEvidence,
181
+ unit_names: set[str],
182
+ manifest: Any | None,
183
+ run_id: str,
184
+ ) -> ResolvedEvidence:
185
+ ref = evidence.ref
186
+ if manifest is None:
187
+ raise CAEError(f"run manifest for '{run_id}' is unavailable")
188
+
189
+ owners: list[tuple[str, str]] = []
190
+ if ref.unit:
191
+ if ref.unit not in unit_names:
192
+ raise CAEError(
193
+ f"artifact owner unit '{ref.unit}' is not declared in the flowsheet"
194
+ )
195
+ owners.append(("unit", ref.unit))
196
+ else:
197
+ owners.extend(("unit", name) for name in getattr(manifest, "units", {}))
198
+ owners.extend(("stream", name) for name in getattr(manifest, "streams", {}))
199
+
200
+ for kind, owner in owners:
201
+ collection = (
202
+ getattr(manifest, "units", {})
203
+ if kind == "unit"
204
+ else getattr(manifest, "streams", {})
205
+ )
206
+ output = collection.get(owner)
207
+ if output is None:
208
+ continue
209
+ for artifact in getattr(output, "artifacts", []):
210
+ if artifact.name != ref.name:
211
+ continue
212
+ location = artifact.local_path or (
213
+ artifact.remote_uris[0] if artifact.remote_uris else ""
214
+ )
215
+ status = "resolved"
216
+ if artifact.local_path and not os.path.exists(artifact.local_path):
217
+ if artifact.remote_uris:
218
+ status = "remote-only"
219
+ else:
220
+ status = "missing"
221
+ return ResolvedEvidence(
222
+ evidence=evidence,
223
+ value=location,
224
+ unit=artifact.kind,
225
+ location=location,
226
+ run_id=run_id,
227
+ status=status,
228
+ )
229
+
230
+ scope = f"unit '{ref.unit}'" if ref.unit else "the run"
231
+ raise CAEError(f"artifact '{ref.name}' was not produced by {scope}")
232
+
233
+
234
+ def _unit_fields(run_summary: dict, name: str) -> dict | None:
235
+ engine = (run_summary.get("engine_outputs") or {}).get(name)
236
+ if engine is not None:
237
+ return engine.get("fields") or {}
238
+
239
+ solver = (run_summary.get("solver_units") or {}).get(name)
240
+ if solver is not None:
241
+ return {
242
+ key: {"value": value, "unit": "", "std_dev": None}
243
+ for key, value in (solver.get("attrs") or {}).items()
244
+ if not key.startswith("_")
245
+ }
246
+ return None
247
+
248
+
249
+ def _require_field(fields: dict, owner: str, name: str | None) -> dict:
250
+ field = fields.get(name) if name else None
251
+ if field is None:
252
+ raise CAEError(
253
+ f"{owner} has no field '{name}' "
254
+ f"(available: {_sorted(fields.keys())})"
255
+ )
256
+ return field
257
+
258
+
259
+ def _extract(field: dict, op: ExtractOp, label: str) -> tuple[Any, str]:
260
+ unit = field.get("unit", "") or ""
261
+ raw = field.get("value")
262
+
263
+ if op == "std_dev":
264
+ std = field.get("std_dev")
265
+ if std is None:
266
+ raise CAEError(f"{label} has no standard deviation")
267
+ return std, unit
268
+
269
+ if op in ("value", "final"):
270
+ if raw is None or (isinstance(raw, (list, tuple)) and not raw):
271
+ raise CAEError(f"{label} has no value")
272
+ return _last_scalar(raw), unit
273
+
274
+ numbers = _numeric_values(raw)
275
+ if not numbers:
276
+ raise CAEError(f"{label} has no numeric values for '{op}'")
277
+ if op == "mean":
278
+ return sum(numbers) / len(numbers), unit
279
+ if op == "max":
280
+ return max(numbers), unit
281
+ if op == "min":
282
+ return min(numbers), unit
283
+ raise CAEError(f"unsupported extraction '{op}'")
284
+
285
+
286
+ def _last_scalar(value: Any) -> Any:
287
+ if isinstance(value, (list, tuple)):
288
+ if not value:
289
+ raise CAEError("empty sequence")
290
+ return value[-1]
291
+ return value
292
+
293
+
294
+ def _numeric_values(value: Any) -> list[float]:
295
+ if value is None:
296
+ return []
297
+ if isinstance(value, bool):
298
+ return []
299
+ if isinstance(value, (int, float)):
300
+ return [] if math.isnan(value) else [float(value)]
301
+ if isinstance(value, (list, tuple)):
302
+ result: list[float] = []
303
+ for item in value:
304
+ result.extend(_numeric_values(item))
305
+ return result
306
+ return []
307
+
308
+
309
+ def _sorted(values: Iterable[str]) -> str:
310
+ return ", ".join(sorted(str(v) for v in values)) or "none"
@@ -0,0 +1,155 @@
1
+ """Local filesystem-backed :class:`CAERepository` implementation."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import os
6
+
7
+ from .loader import (
8
+ CASES_DIRNAME,
9
+ CAEError,
10
+ iter_case_paths,
11
+ load_case,
12
+ load_index,
13
+ select_version,
14
+ version_key,
15
+ )
16
+ from .repository import CAERepository
17
+ from .types import CAECase, CAECaseLink, CAECaseRef
18
+
19
+
20
+ class FileCAERepository(CAERepository):
21
+ """Read CAE cases from a local ``cae/`` directory.
22
+
23
+ Layout::
24
+
25
+ cae/
26
+ ├── index.yaml
27
+ └── cases/
28
+ ├── closed-loop-cae.ca.yaml
29
+ └── hydraulic-cae.ca.yaml
30
+ """
31
+
32
+ def __init__(self, root: str) -> None:
33
+ self.root = os.path.abspath(os.path.expanduser(root))
34
+ self._cases_dir = os.path.join(self.root, CASES_DIRNAME)
35
+ self._cases: dict[tuple[str, str], CAECase] | None = None
36
+ self._index = None
37
+
38
+ # ------------------------------------------------------------------
39
+ # Index / case loading
40
+ # ------------------------------------------------------------------
41
+ @property
42
+ def index(self):
43
+ if self._index is None:
44
+ self._index = load_index(self.root)
45
+ return self._index
46
+
47
+ def _load_all(self) -> dict[tuple[str, str], CAECase]:
48
+ if self._cases is not None:
49
+ return self._cases
50
+
51
+ cases: dict[tuple[str, str], CAECase] = {}
52
+ paths: dict[tuple[str, str], str] = {}
53
+ for path in iter_case_paths(self._cases_dir):
54
+ case = load_case(path)
55
+ key = (case.case.id, case.case.version)
56
+ if key in cases:
57
+ raise CAEError(
58
+ f"duplicate CAE case '{case.case.id}' version "
59
+ f"'{case.case.version}' in '{paths[key]}' and '{path}'"
60
+ )
61
+ cases[key] = case
62
+ paths[key] = path
63
+ self._cases = cases
64
+ return cases
65
+
66
+ def list_cases(self) -> list[CAECaseRef]:
67
+ refs = [
68
+ CAECaseRef(
69
+ case_id=case.case.id,
70
+ version=case.case.version,
71
+ title=case.case.title,
72
+ jurisdictions=case.jurisdictions(),
73
+ )
74
+ for case in self._load_all().values()
75
+ ]
76
+ return sorted(refs, key=lambda ref: (ref.case_id, version_key(ref.version)))
77
+
78
+ def load_case(self, case_id: str, version: str | None = None) -> CAECase:
79
+ cases = self._load_all()
80
+ versions = [v for (cid, v) in cases if cid == case_id]
81
+ chosen = select_version(versions, version)
82
+ if chosen is None:
83
+ available = ", ".join(sorted(versions, key=version_key)) or "none"
84
+ if version:
85
+ raise CAEError(
86
+ f"CAE case '{case_id}' has no version '{version}' "
87
+ f"(available: {available})"
88
+ )
89
+ raise CAEError(f"CAE case '{case_id}' not found (available: {available})")
90
+ return cases[(case_id, chosen)]
91
+
92
+ # ------------------------------------------------------------------
93
+ # Flowsheet links
94
+ # ------------------------------------------------------------------
95
+ def links_for_flowsheet(self, flowsheet_path: str) -> list[CAECaseLink]:
96
+ best_score = 0
97
+ best_links: list[CAECaseLink] = []
98
+ matches: list[str] = []
99
+
100
+ for entry in self.index.flowsheets:
101
+ score = self._match_score(entry.path, flowsheet_path)
102
+ if score == 0:
103
+ continue
104
+ if score > best_score:
105
+ best_score = score
106
+ best_links = list(entry.cases)
107
+ matches = [entry.path]
108
+ elif score == best_score:
109
+ matches.append(entry.path)
110
+
111
+ if best_score == 0:
112
+ raise CAEError(
113
+ f"No CAE case linked to flowsheet '{flowsheet_path}'. "
114
+ f"Add it to '{os.path.join(self.root, 'index.yaml')}'."
115
+ )
116
+ if len(matches) > 1:
117
+ raise CAEError(
118
+ f"Ambiguous CAE index entries for flowsheet '{flowsheet_path}': "
119
+ f"{matches}. Use a more specific path."
120
+ )
121
+ return best_links
122
+
123
+ def _match_score(self, indexed_path: str, flowsheet_path: str) -> int:
124
+ repo_root = os.path.dirname(self.root)
125
+ indexed_abs = _abspath(indexed_path, repo_root)
126
+ given_abs = os.path.abspath(os.path.expanduser(flowsheet_path))
127
+
128
+ if indexed_abs == given_abs:
129
+ return 100
130
+
131
+ indexed_rel = os.path.normpath(indexed_path)
132
+ given_rel = os.path.normpath(flowsheet_path)
133
+ if indexed_rel == given_rel:
134
+ return 90
135
+
136
+ indexed_name = os.path.splitext(os.path.basename(indexed_path))[0]
137
+ given_name = os.path.splitext(os.path.basename(flowsheet_path))[0]
138
+ if indexed_name != given_name:
139
+ return 0
140
+
141
+ # Same basename: prefer a match on the trailing path components.
142
+ if indexed_rel.endswith(given_rel) or given_rel.endswith(indexed_rel):
143
+ return 80
144
+ indexed_parent = os.path.basename(os.path.dirname(indexed_rel))
145
+ given_parent = os.path.basename(os.path.dirname(given_rel))
146
+ if indexed_parent and indexed_parent == given_parent:
147
+ return 60
148
+ return 40
149
+
150
+
151
+ def _abspath(path: str, base: str) -> str:
152
+ expanded = os.path.expanduser(path)
153
+ if os.path.isabs(expanded):
154
+ return os.path.abspath(expanded)
155
+ return os.path.abspath(os.path.join(base, expanded))