processforge 0.6.2__tar.gz → 0.6.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (164) hide show
  1. {processforge-0.6.2/src/processforge.egg-info → processforge-0.6.4}/PKG-INFO +2 -2
  2. {processforge-0.6.2 → processforge-0.6.4}/pyproject.toml +2 -2
  3. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/__init__.py +1 -5
  4. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/init.py +0 -24
  5. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/run.py +1 -6
  6. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/runs.py +16 -0
  7. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/output_collector.py +1 -1
  8. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/provenance.py +1 -1
  9. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/result.py +0 -80
  10. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/runner.py +11 -9
  11. processforge-0.6.4/src/processforge/utils/plotting.py +171 -0
  12. {processforge-0.6.2 → processforge-0.6.4/src/processforge.egg-info}/PKG-INFO +2 -2
  13. {processforge-0.6.2 → processforge-0.6.4}/src/processforge.egg-info/SOURCES.txt +1 -0
  14. {processforge-0.6.2 → processforge-0.6.4}/src/processforge.egg-info/requires.txt +1 -1
  15. {processforge-0.6.2 → processforge-0.6.4}/tests/test_cli.py +4 -4
  16. {processforge-0.6.2 → processforge-0.6.4}/LICENSE +0 -0
  17. {processforge-0.6.2 → processforge-0.6.4}/MANIFEST.in +0 -0
  18. {processforge-0.6.2 → processforge-0.6.4}/README.md +0 -0
  19. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/closed-loop-chain.json +0 -0
  20. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/coupled/msre_coupled.json +0 -0
  21. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/custom/crimson/MUWS_HB.json +0 -0
  22. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/custom/crimson/simple_water_system.json +0 -0
  23. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/custom/simple_hyrdaulic_scheme.json +0 -0
  24. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/festim/hydrogen_transport_1d.json +0 -0
  25. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/festim/tds_tungsten.json +0 -0
  26. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/hydraulic-chain.json +0 -0
  27. {processforge-0.6.2 → processforge-0.6.4}/flowsheets/openmc/msre_eigenvalue.json +0 -0
  28. {processforge-0.6.2 → processforge-0.6.4}/setup.cfg +0 -0
  29. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/__main__.py +0 -0
  30. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/_schema.py +0 -0
  31. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/analysis/__init__.py +0 -0
  32. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/analysis/dof.py +0 -0
  33. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/api/__init__.py +0 -0
  34. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/api/serve.py +0 -0
  35. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/__init__.py +0 -0
  36. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/apply.py +0 -0
  37. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/common.py +0 -0
  38. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/diagram.py +0 -0
  39. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/display.py +0 -0
  40. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/export_fmu.py +0 -0
  41. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/export_modelica.py +0 -0
  42. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/persist.py +0 -0
  43. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/plan.py +0 -0
  44. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/cli/validate.py +0 -0
  45. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/compose.py +0 -0
  46. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/coupling.py +0 -0
  47. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/__init__.py +0 -0
  48. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/backends/__init__.py +0 -0
  49. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/backends/base.py +0 -0
  50. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/backends/casadi_backend.py +0 -0
  51. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/backends/pyomo_backend.py +0 -0
  52. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/backends/scipy_backend.py +0 -0
  53. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/flowsheet.py +0 -0
  54. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/jacobian.py +0 -0
  55. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/mixin.py +0 -0
  56. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/solver.py +0 -0
  57. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/stream_var.py +0 -0
  58. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/units/__init__.py +0 -0
  59. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/units/flash_eo.py +0 -0
  60. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/units/heater_eo.py +0 -0
  61. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/units/pipes_eo.py +0 -0
  62. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/units/pump_eo.py +0 -0
  63. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/units/strainer_eo.py +0 -0
  64. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/eo/units/valve_eo.py +0 -0
  65. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/flowsheet.py +0 -0
  66. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/fmu/__init__.py +0 -0
  67. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/fmu/_fmi_vars.py +0 -0
  68. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/fmu/builder.py +0 -0
  69. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/fmu/interface.py +0 -0
  70. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/fmu/slave_template.py +0 -0
  71. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/lock.py +0 -0
  72. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/modelica/__init__.py +0 -0
  73. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/modelica/mo_writer.py +0 -0
  74. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/modelica/omc_runner.py +0 -0
  75. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/modelica/transpiler.py +0 -0
  76. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/modelica/unit_equations.py +0 -0
  77. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/pathsim/__init__.py +0 -0
  78. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/pathsim/adapter.py +0 -0
  79. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/pcl/__init__.py +0 -0
  80. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/pcl/compiler.py +0 -0
  81. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/pcl/namespace.py +0 -0
  82. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/persistence/__init__.py +0 -0
  83. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/persistence/archive.py +0 -0
  84. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/persistence/artifact_store.py +0 -0
  85. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/__init__.py +0 -0
  86. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/_sim_strategy.py +0 -0
  87. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/base.py +0 -0
  88. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/base_jacobian_mixin.py +0 -0
  89. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/base_simulation_provider.py +0 -0
  90. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/cantera_jacobian.py +0 -0
  91. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/cantera_provider.py +0 -0
  92. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/container_client.py +0 -0
  93. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/coolprop_provider.py +0 -0
  94. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/errors.py +0 -0
  95. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/festim/__init__.py +0 -0
  96. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/festim/build_helpers.py +0 -0
  97. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/festim/provider.py +0 -0
  98. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/festim/result_extraction.py +0 -0
  99. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/festim/strategies.py +0 -0
  100. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/jacobian_contributor.py +0 -0
  101. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/manager.py +0 -0
  102. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/modelica_jacobian.py +0 -0
  103. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/modelica_provider.py +0 -0
  104. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/openmc/__init__.py +0 -0
  105. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/openmc/build_helpers.py +0 -0
  106. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/openmc/provider.py +0 -0
  107. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/openmc/result_extraction.py +0 -0
  108. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/openmc/strategies.py +0 -0
  109. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/reference_state_registry.py +0 -0
  110. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/providers/registry.py +0 -0
  111. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/quantity.py +0 -0
  112. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/result_schema.py +0 -0
  113. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/schemas/__init__.py +0 -0
  114. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/schemas/festim/festim_model.py +0 -0
  115. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/schemas/flowsheet_schema.json +0 -0
  116. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/schemas/openmc/openmc_model.py +0 -0
  117. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/simulate.py +0 -0
  118. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/solver.py +0 -0
  119. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/state.py +0 -0
  120. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/thermo.py +0 -0
  121. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/types.py +0 -0
  122. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/__init__.py +0 -0
  123. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/base.py +0 -0
  124. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/cstr.py +0 -0
  125. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/flash.py +0 -0
  126. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/heater.py +0 -0
  127. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/pfr.py +0 -0
  128. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/pipes.py +0 -0
  129. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/pump.py +0 -0
  130. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/registry.py +0 -0
  131. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/solver_unit.py +0 -0
  132. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/strainer.py +0 -0
  133. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/tank.py +0 -0
  134. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/units/valve.py +0 -0
  135. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/utils/__init__.py +0 -0
  136. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/utils/flowsheet_diagram.py +0 -0
  137. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/utils/mermaid_diagram.py +0 -0
  138. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/utils/s3_upload.py +0 -0
  139. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/utils/topology.py +0 -0
  140. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/utils/unit_consistency.py +0 -0
  141. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/utils/validate_flowsheet.py +0 -0
  142. {processforge-0.6.2 → processforge-0.6.4}/src/processforge/utils/validation.py +0 -0
  143. {processforge-0.6.2 → processforge-0.6.4}/src/processforge.egg-info/dependency_links.txt +0 -0
  144. {processforge-0.6.2 → processforge-0.6.4}/src/processforge.egg-info/entry_points.txt +0 -0
  145. {processforge-0.6.2 → processforge-0.6.4}/src/processforge.egg-info/top_level.txt +0 -0
  146. {processforge-0.6.2 → processforge-0.6.4}/tests/test_artifact_store.py +0 -0
  147. {processforge-0.6.2 → processforge-0.6.4}/tests/test_container_client.py +0 -0
  148. {processforge-0.6.2 → processforge-0.6.4}/tests/test_coupling.py +0 -0
  149. {processforge-0.6.2 → processforge-0.6.4}/tests/test_display.py +0 -0
  150. {processforge-0.6.2 → processforge-0.6.4}/tests/test_festim_provider.py +0 -0
  151. {processforge-0.6.2 → processforge-0.6.4}/tests/test_festim_schema.py +0 -0
  152. {processforge-0.6.2 → processforge-0.6.4}/tests/test_fmu_solverunit.py +0 -0
  153. {processforge-0.6.2 → processforge-0.6.4}/tests/test_init.py +0 -0
  154. {processforge-0.6.2 → processforge-0.6.4}/tests/test_openmc_provider.py +0 -0
  155. {processforge-0.6.2 → processforge-0.6.4}/tests/test_pathsim_adapter.py +0 -0
  156. {processforge-0.6.2 → processforge-0.6.4}/tests/test_persist.py +0 -0
  157. {processforge-0.6.2 → processforge-0.6.4}/tests/test_provider_errors.py +0 -0
  158. {processforge-0.6.2 → processforge-0.6.4}/tests/test_providers.py +0 -0
  159. {processforge-0.6.2 → processforge-0.6.4}/tests/test_result_zarr.py +0 -0
  160. {processforge-0.6.2 → processforge-0.6.4}/tests/test_runner.py +0 -0
  161. {processforge-0.6.2 → processforge-0.6.4}/tests/test_runs_command.py +0 -0
  162. {processforge-0.6.2 → processforge-0.6.4}/tests/test_s3_upload.py +0 -0
  163. {processforge-0.6.2 → processforge-0.6.4}/tests/test_state.py +0 -0
  164. {processforge-0.6.2 → processforge-0.6.4}/tests/test_types.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: processforge
3
- Version: 0.6.2
3
+ Version: 0.6.4
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
@@ -22,8 +22,8 @@ License-File: LICENSE
22
22
  Requires-Dist: numpy>=2.0
23
23
  Requires-Dist: pydantic>=2.0
24
24
  Requires-Dist: scipy>=1.14
25
- Requires-Dist: matplotlib>=3.9
26
25
  Requires-Dist: loguru>=0.7
26
+ Requires-Dist: plotext>=5.2
27
27
  Requires-Dist: jsonschema>=4.20
28
28
  Requires-Dist: graphviz>=0.20
29
29
  Requires-Dist: pandas>=2.2
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "processforge"
7
- version = "0.6.2"
7
+ version = "0.6.4"
8
8
  description = "A Python-based process simulation framework for chemical engineering applications."
9
9
  readme = "README.md"
10
10
  license = "BSD-3-Clause"
@@ -28,8 +28,8 @@ dependencies = [
28
28
  "numpy>=2.0",
29
29
  "pydantic>=2.0",
30
30
  "scipy>=1.14",
31
- "matplotlib>=3.9",
32
31
  "loguru>=0.7",
32
+ "plotext>=5.2",
33
33
  "jsonschema>=4.20",
34
34
  "graphviz>=0.20",
35
35
  "pandas>=2.2",
@@ -10,14 +10,12 @@ 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"
13
+ __version__ = "0.6.4"
14
14
 
15
15
  from .eo import EOFlowsheet, EOSolver
16
16
  from .flowsheet import Flowsheet
17
17
  from .provenance import build_run_info
18
18
  from .result import (
19
- plot_results,
20
- plot_timeseries,
21
19
  save_results_zarr,
22
20
  )
23
21
  from .runner import (
@@ -66,8 +64,6 @@ __all__ = [
66
64
  "__version__",
67
65
  "apply_flowsheet",
68
66
  "build_run_info",
69
- "plot_results",
70
- "plot_timeseries",
71
67
  "rachford_rice",
72
68
  "run_flowsheet",
73
69
  "save_results_zarr",
@@ -3,7 +3,6 @@
3
3
  from __future__ import annotations
4
4
 
5
5
  import importlib.util
6
- import json
7
6
  import os
8
7
  import shutil
9
8
  import subprocess
@@ -116,29 +115,6 @@ def init(
116
115
  # dir so existing repos aren't silently broken by the new structure.
117
116
  _migrate_legacy_env(pf_dir)
118
117
 
119
- # Write config.json (always)
120
- config_path = os.path.join(pf_dir, "config.json")
121
- if not os.path.exists(config_path):
122
- default_config = {
123
- "version": 1,
124
- "default_backend": "scipy",
125
- "outputs_dir": "outputs",
126
- }
127
- with open(config_path, "w", encoding="utf-8") as f:
128
- json.dump(default_config, f, indent=2)
129
- logger.info(f"Created {config_path}")
130
- else:
131
- logger.info(f"{config_path} already exists — skipped.")
132
-
133
- # Honour a configured outputs_dir for the rest of init.
134
- outputs_dir_name = "outputs"
135
- try:
136
- with open(config_path, encoding="utf-8") as f:
137
- outputs_dir_name = json.load(f).get("outputs_dir", "outputs")
138
- except Exception:
139
- pass
140
- outputs_dir = os.path.join(root, outputs_dir_name)
141
-
142
118
  # Remove stale .pfstate snapshot directories from outputs/
143
119
  stale_count = 0
144
120
  for entry in os.listdir(outputs_dir):
@@ -9,15 +9,10 @@ from ..runner import ProcessforgeRunError, run_flowsheet
9
9
 
10
10
  def run(
11
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
12
  ) -> None:
18
13
  """Run a process simulation from a flowsheet JSON file."""
19
14
  try:
20
- result = run_flowsheet(flowsheet, export_images=export_images)
15
+ result = run_flowsheet(flowsheet, no_plot=True)
21
16
  except ProcessforgeRunError as exc:
22
17
  logger.error(str(exc))
23
18
  raise SystemExit(1) from exc
@@ -17,6 +17,7 @@ from ..result import (
17
17
  _scalar_from_sequence,
18
18
  summarize_zarr_store,
19
19
  )
20
+ from ..utils.plotting import plot_zarr_summary_terminal
20
21
 
21
22
  # Fixed column widths for the compact single-run stream table.
22
23
  STREAM_COL_WIDTH = 28
@@ -157,6 +158,11 @@ def runs(
157
158
  "--schema",
158
159
  help="Print the result schema JSON instead of the summary.",
159
160
  ),
161
+ no_plot: bool = typer.Option(
162
+ False,
163
+ "--no-plot",
164
+ help="Skip terminal plots for the run summary.",
165
+ ),
160
166
  ):
161
167
  """List runs for a flowsheet, or inspect one run's Zarr result summary."""
162
168
  base = flowsheet_basename(flowsheet)
@@ -197,6 +203,16 @@ def runs(
197
203
  manifest = archive.load_run(resolved_id)
198
204
  summary = summarize_zarr_store(zarr_path)
199
205
  summary["_zarr_path"] = zarr_path
206
+
207
+ if not no_plot:
208
+ plot_title = f"{base} / {resolved_id}"
209
+ try:
210
+ plot_zarr_summary_terminal(summary, title=plot_title)
211
+ except Exception as exc: # noqa: BLE001
212
+ logger.warning(
213
+ f"Failed to render terminal plots: {type(exc).__name__}: {exc}"
214
+ )
215
+
200
216
  typer.echo(_format_run_compact(manifest, summary))
201
217
  return
202
218
 
@@ -36,7 +36,7 @@ def _to_scalar(value):
36
36
 
37
37
  Dynamic simulations store stream properties as timeseries lists. For
38
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`.
39
+ scalar, matching the convention used by terminal result plots.
40
40
  """
41
41
  if isinstance(value, (list, tuple, np.ndarray)):
42
42
  arr = np.asarray(value)
@@ -18,7 +18,7 @@ _KEY_PACKAGES = [
18
18
  "loguru",
19
19
  "pandas",
20
20
  "openpyxl",
21
- "matplotlib",
21
+ "plotext",
22
22
  "jsonschema",
23
23
  "graphviz",
24
24
  ]
@@ -5,7 +5,6 @@ from datetime import datetime, timezone
5
5
 
6
6
  import numpy as np
7
7
  import pandas as pd
8
- import matplotlib.pyplot as plt
9
8
  import zarr
10
9
  from loguru import logger
11
10
 
@@ -355,85 +354,6 @@ def save_results_zarr_s3(results, s3_uri: str, run_info: RunInfo | dict | None =
355
354
  logger.info(f"Saved Zarr results to {s3_uri}")
356
355
 
357
356
 
358
- def plot_results(results, fname="results.png"):
359
- os.makedirs("outputs", exist_ok=True)
360
- streams = list(results.keys())
361
- temp_values = [_scalar_from_sequence(results[s].get("T")) or 0.0 for s in streams]
362
-
363
- plt.figure(figsize=(8, 4))
364
- plt.bar(streams, temp_values, color="skyblue")
365
- plt.ylabel("Temperature [K]")
366
- plt.title("Stream Temperatures (Steady State)")
367
- plt.tight_layout()
368
- plt.savefig(os.path.join("outputs", "temps_" + fname))
369
- plt.close()
370
-
371
- comps = set()
372
- for s in results.values():
373
- comps.update(s.get("z", {}).keys())
374
- comps = sorted(comps)
375
-
376
- bottom = [0.0] * len(streams)
377
- plt.figure(figsize=(8, 4))
378
- for comp in comps:
379
- vals = [
380
- _scalar_from_sequence(results[s].get("z", {}).get(comp, 0.0)) or 0.0
381
- for s in streams
382
- ]
383
- plt.bar(streams, vals, bottom=bottom, label=comp)
384
- bottom = [bottom[i] + vals[i] for i in range(len(vals))]
385
- plt.ylabel("Mole Fraction")
386
- plt.title("Stream Compositions (Steady State)")
387
- plt.legend()
388
- plt.tight_layout()
389
- plt.savefig(os.path.join("outputs", "comps_" + fname))
390
- plt.close()
391
-
392
-
393
- def plot_timeseries(results, fname="timeseries.png"):
394
- os.makedirs("outputs", exist_ok=True)
395
- streams = sorted(results.keys())
396
- if not streams:
397
- return
398
-
399
- times = results[streams[0]].get("time", [])
400
- if not times:
401
- return
402
-
403
- plt.figure(figsize=(8, 5))
404
- for s_name in streams:
405
- if "T" in results[s_name]:
406
- plt.plot(times, results[s_name]["T"], label=s_name)
407
- plt.xlabel("Time [s]")
408
- plt.ylabel("Temperature [K]")
409
- plt.title("Stream Temperatures vs Time")
410
- plt.legend()
411
- plt.tight_layout()
412
- plt.savefig(os.path.join("outputs", "temps_" + fname))
413
- plt.close()
414
-
415
- comps = set()
416
- for s_data in results.values():
417
- if "z" in s_data and isinstance(s_data["z"], dict):
418
- comps.update(s_data["z"].keys())
419
- comps = sorted(comps)
420
-
421
- for s_name in streams:
422
- if "z" not in results[s_name]:
423
- continue
424
- plt.figure(figsize=(8, 5))
425
- for comp in comps:
426
- if comp in results[s_name]["z"]:
427
- plt.plot(times, results[s_name]["z"][comp], label=comp)
428
- plt.xlabel("Time [s]")
429
- plt.ylabel("Mole Fraction")
430
- plt.title(f"Compositions vs Time ({s_name})")
431
- plt.legend()
432
- plt.tight_layout()
433
- plt.savefig(os.path.join("outputs", f"comps_{s_name}_" + fname))
434
- plt.close()
435
-
436
-
437
357
  def _convert_value(value):
438
358
  if isinstance(value, np.ndarray):
439
359
  if value.size == 0:
@@ -399,7 +399,7 @@ def run_flowsheet(
399
399
  *,
400
400
  outputs_dir: str | None = None,
401
401
  backend: Literal["scipy", "pyomo", "casadi"] | None = None,
402
- export_images: bool = False,
402
+ no_plot: bool = False,
403
403
  s3_bucket: str | None = None,
404
404
  s3_prefix: str | None = None,
405
405
  ) -> RunResult:
@@ -410,7 +410,7 @@ def run_flowsheet(
410
410
  outputs_dir: Directory for local pfarchive output. Defaults to
411
411
  ``PROCESSFORGE_OUTPUT_DIR`` or ``outputs/``.
412
412
  backend: Optional EO solver backend override (``scipy``/``pyomo``/``casadi``).
413
- export_images: If ``True``, generate PNG plots of the results.
413
+ no_plot: If ``True``, skip terminal plots of the results.
414
414
  s3_bucket: S3 bucket for archive upload. Defaults to ``S3_BUCKET`` env var.
415
415
  s3_prefix: S3 key prefix. Defaults to ``S3_PREFIX`` env var or
416
416
  ``"processforge"``.
@@ -546,17 +546,19 @@ def run_flowsheet(
546
546
  s3_prefix=s3_prefix,
547
547
  )
548
548
 
549
- if export_images:
549
+ if not no_plot:
550
550
  try:
551
- from .result import plot_results, plot_timeseries
551
+ from .utils.plotting import plot_results_to_terminal
552
552
 
553
- plot_results(results, fname=f"{base_name}_results.png")
554
- plot_timeseries(results, fname=f"{base_name}_timeseries.png")
555
- logger.info(
556
- f"Plots saved: {base_name}_results.png, {base_name}_timeseries.png"
553
+ plot_results_to_terminal(
554
+ results,
555
+ title=f"{base_name} / {run_id}",
556
+ mode=mode,
557
557
  )
558
558
  except Exception as exc: # noqa: BLE001
559
- logger.warning(f"Failed to generate plots: {type(exc).__name__}: {exc}")
559
+ logger.warning(
560
+ f"Failed to render terminal plots: {type(exc).__name__}: {exc}"
561
+ )
560
562
 
561
563
  return result
562
564
 
@@ -0,0 +1,171 @@
1
+ """Terminal plotting helpers for processforge run results."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import numpy as np
6
+ import plotext as plt
7
+
8
+ from ..result import _convert_value, _scalar_from_sequence
9
+
10
+ # Default terminal plot dimensions.
11
+ _DEFAULT_WIDTH = 80
12
+ _DEFAULT_HEIGHT = 18
13
+ _MAX_WIDTH = 120
14
+ _MAX_HEIGHT = 40
15
+
16
+
17
+ def _plotext_figure(width: int = _DEFAULT_WIDTH, height: int = _DEFAULT_HEIGHT):
18
+ """Return a fresh plotext figure with a sensible terminal size."""
19
+ fig = plt.figure
20
+ fig.clear()
21
+ fig.plot_size(width, height)
22
+ fig.theme("dark")
23
+ return fig
24
+
25
+
26
+ def _shorten_labels(labels, max_len: int = 14):
27
+ """Shorten long labels while preserving readability."""
28
+ return [lab if len(lab) <= max_len else lab[: max_len - 1] + "…" for lab in labels]
29
+
30
+
31
+ def _bar_figure(n_categories: int, max_label_len: int):
32
+ """Create a figure sized appropriately for a bar chart.
33
+
34
+ Uses horizontal bars when there are many categories or long labels,
35
+ vertical bars otherwise.
36
+ """
37
+ use_horizontal = n_categories > 6 or max_label_len > 12
38
+ if use_horizontal:
39
+ height = min(_MAX_HEIGHT, max(_DEFAULT_HEIGHT, n_categories * 2 + 6))
40
+ return _plotext_figure(width=_DEFAULT_WIDTH, height=height), "horizontal"
41
+ width = min(_MAX_WIDTH, max(_DEFAULT_WIDTH, n_categories * 12))
42
+ return _plotext_figure(width=width, height=_DEFAULT_HEIGHT), "vertical"
43
+
44
+
45
+ def plot_results_terminal(results, title=""):
46
+ """Render steady-state stream results as terminal bar charts."""
47
+ streams = [k for k, v in results.items() if isinstance(v, dict) and "T" in v]
48
+ if not streams:
49
+ return
50
+
51
+ temp_values = [_scalar_from_sequence(results[s].get("T")) or 0.0 for s in streams]
52
+ labels = _shorten_labels(streams)
53
+ max_len = max((len(lab) for lab in labels), default=0)
54
+
55
+ fig, orientation = _bar_figure(len(streams), max_len)
56
+ fig.draw(fig.bar(labels, temp_values, orientation=orientation, width=0.5))
57
+ fig.title(title or "Stream Temperatures (Steady State)")
58
+ if orientation == "horizontal":
59
+ fig.label("Temperature (K)", axis="x")
60
+ fig.label("Stream", axis="y")
61
+ else:
62
+ fig.label("Stream", axis="x")
63
+ fig.label("Temperature (K)", axis="y")
64
+ fig.show()
65
+ fig.clear()
66
+
67
+ comps = set()
68
+ for s in streams:
69
+ z = results[s].get("z")
70
+ if isinstance(z, dict):
71
+ comps.update(z.keys())
72
+ comps = sorted(comps)
73
+ if not comps:
74
+ return
75
+
76
+ values = []
77
+ for comp in comps:
78
+ values.append([
79
+ _scalar_from_sequence(results[s].get("z", {}).get(comp, 0.0)) or 0.0
80
+ for s in streams
81
+ ])
82
+
83
+ fig, orientation = _bar_figure(len(streams), max_len)
84
+ fig.draw(fig.bar(labels, values, orientation=orientation, stacked=True, width=0.5))
85
+ fig.title(title or "Stream Compositions (Steady State)")
86
+ if orientation == "horizontal":
87
+ fig.label("Mole fraction", axis="x")
88
+ fig.label("Stream", axis="y")
89
+ else:
90
+ fig.label("Stream", axis="x")
91
+ fig.label("Mole fraction", axis="y")
92
+ fig.show()
93
+ fig.clear()
94
+
95
+
96
+ def plot_timeseries_terminal(results, title=""):
97
+ """Render dynamic stream results as terminal line plots."""
98
+ streams = sorted(k for k, v in results.items() if isinstance(v, dict))
99
+ if not streams:
100
+ return
101
+
102
+ times = results[streams[0]].get("time", [])
103
+ if not times:
104
+ return
105
+
106
+ n_points = len(times)
107
+ width = min(_MAX_WIDTH, max(_DEFAULT_WIDTH, n_points // 2))
108
+
109
+ fig = _plotext_figure(width=width, height=_DEFAULT_HEIGHT)
110
+ for s_name in streams:
111
+ if "T" in results[s_name]:
112
+ fig.draw(fig.signal(times, results[s_name]["T"]).label(s_name))
113
+ fig.title(title or "Stream Temperatures vs Time")
114
+ fig.label("Time (s)", axis="x")
115
+ fig.label("Temperature (K)", axis="y")
116
+ fig.show()
117
+ fig.clear()
118
+
119
+ comps = set()
120
+ for s_data in results.values():
121
+ if "z" in s_data and isinstance(s_data["z"], dict):
122
+ comps.update(s_data["z"].keys())
123
+ comps = sorted(comps)
124
+
125
+ for s_name in streams:
126
+ if "z" not in results[s_name]:
127
+ continue
128
+ fig = _plotext_figure(width=width, height=_DEFAULT_HEIGHT)
129
+ for comp in comps:
130
+ if comp in results[s_name]["z"]:
131
+ fig.draw(fig.signal(times, results[s_name]["z"][comp]).label(comp))
132
+ fig.title(f"Compositions vs Time ({s_name})")
133
+ fig.label("Time (s)", axis="x")
134
+ fig.label("Mole fraction", axis="y")
135
+ fig.show()
136
+ fig.clear()
137
+
138
+
139
+ def plot_zarr_summary_terminal(summary: dict, title: str = "") -> None:
140
+ """Render a terminal visualization from a Zarr summary dict."""
141
+ if not summary.get("present"):
142
+ return
143
+
144
+ mode = summary.get("mode", "steady")
145
+ streams = summary.get("streams", {})
146
+
147
+ if mode == "dynamic":
148
+ # Reconstruct a results-like dict from Zarr summary for plotting.
149
+ results: dict = {}
150
+ for s_name, sdata in streams.items():
151
+ fields = sdata.get("fields", {})
152
+ results[s_name] = {k: v.get("value") for k, v in fields.items()}
153
+ plot_timeseries_terminal(results, title=title)
154
+ else:
155
+ # Steady: show final timestep values.
156
+ results = {}
157
+ for s_name, sdata in streams.items():
158
+ fields = sdata.get("fields", {})
159
+ results[s_name] = {
160
+ k: _scalar_from_sequence(v.get("value"))
161
+ for k, v in fields.items()
162
+ }
163
+ plot_results_terminal(results, title=title)
164
+
165
+
166
+ def plot_results_to_terminal(results, title: str = "", mode: str = "steady") -> None:
167
+ """Dispatch to the appropriate terminal plotter for run results."""
168
+ if mode == "dynamic":
169
+ plot_timeseries_terminal(results, title=title)
170
+ else:
171
+ plot_results_terminal(results, title=title)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: processforge
3
- Version: 0.6.2
3
+ Version: 0.6.4
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
@@ -22,8 +22,8 @@ License-File: LICENSE
22
22
  Requires-Dist: numpy>=2.0
23
23
  Requires-Dist: pydantic>=2.0
24
24
  Requires-Dist: scipy>=1.14
25
- Requires-Dist: matplotlib>=3.9
26
25
  Requires-Dist: loguru>=0.7
26
+ Requires-Dist: plotext>=5.2
27
27
  Requires-Dist: jsonschema>=4.20
28
28
  Requires-Dist: graphviz>=0.20
29
29
  Requires-Dist: pandas>=2.2
@@ -134,6 +134,7 @@ src/processforge/units/valve.py
134
134
  src/processforge/utils/__init__.py
135
135
  src/processforge/utils/flowsheet_diagram.py
136
136
  src/processforge/utils/mermaid_diagram.py
137
+ src/processforge/utils/plotting.py
137
138
  src/processforge/utils/s3_upload.py
138
139
  src/processforge/utils/topology.py
139
140
  src/processforge/utils/unit_consistency.py
@@ -1,8 +1,8 @@
1
1
  numpy>=2.0
2
2
  pydantic>=2.0
3
3
  scipy>=1.14
4
- matplotlib>=3.9
5
4
  loguru>=0.7
5
+ plotext>=5.2
6
6
  jsonschema>=4.20
7
7
  graphviz>=0.20
8
8
  pandas>=2.2
@@ -286,7 +286,7 @@ class TestCmdInit:
286
286
  from processforge.cli.init import init
287
287
 
288
288
  init(flowsheet=None, path=str(tmp_path))
289
- assert (tmp_path / ".processforge" / "config.json").exists()
289
+ assert not (tmp_path / ".processforge" / "config.json").exists()
290
290
  assert (tmp_path / "outputs").is_dir()
291
291
  assert any("initialised successfully" in m for m in log_output)
292
292
 
@@ -327,7 +327,7 @@ class TestCmdInit:
327
327
  from processforge.lock import read_lock
328
328
 
329
329
  init(flowsheet=str(coolprop_flowsheet), path=str(tmp_path))
330
- assert (tmp_path / ".processforge" / "config.json").exists()
330
+ assert not (tmp_path / ".processforge" / "config.json").exists()
331
331
  lock = read_lock(str(tmp_path / ".processforge"), str(coolprop_flowsheet))
332
332
  assert lock is not None
333
333
  assert "coolprop" in lock["providers"]
@@ -374,7 +374,7 @@ class TestCmdRun:
374
374
  with patch.object(
375
375
  runner_mod, "run_flowsheet", side_effect=FlowsheetValidationError("not found")
376
376
  ), pytest.raises(SystemExit) as exc_info:
377
- run(flowsheet=str(tmp_path / "nope.json"), export_images=False)
377
+ run(flowsheet=str(tmp_path / "nope.json"))
378
378
  assert exc_info.value.code == 1
379
379
 
380
380
  def test_run_flowsheet_delegates_to_runner(self, tmp_path, log_output):
@@ -382,7 +382,7 @@ class TestCmdRun:
382
382
  from processforge.cli.run import run
383
383
 
384
384
  with patch.object(run_mod, "run_flowsheet", return_value=self._mock_result()):
385
- run(flowsheet=str(tmp_path / "fs.json"), export_images=False)
385
+ run(flowsheet=str(tmp_path / "fs.json"))
386
386
 
387
387
  assert any("Run Summary" in m for m in log_output)
388
388
  assert any("converged" in m for m in log_output)
File without changes
File without changes
File without changes
File without changes