processforge 0.2.34__tar.gz → 0.2.38__tar.gz

{processforge-0.2.34 → processforge-0.2.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: processforge
-Version: 0.2.34
+Version: 0.2.38
 Summary: A Python-based process simulation framework for chemical engineering applications.
 Author-email: Processforge Team <team@processforge.dev>
 License-Expression: BSD-3-Clause
@@ -29,8 +29,6 @@ Requires-Dist: graphviz>=0.20
 Requires-Dist: pandas>=2.2
 Requires-Dist: zarr>=3.0
 Requires-Dist: coolprop>=7.2.0
-Requires-Dist: pi>=0.1.2
-Requires-Dist: pip>=26.1.2
 Provides-Extra: eo
 Requires-Dist: pyomo>=6.7; extra == "eo"
 Provides-Extra: eo-casadi
@@ -66,38 +64,58 @@ A lightweight Python framework for process simulation, coupling hydraulic, therm
 
 ## Install
 
+Install the `pf` command-line tool with [uv](https://docs.astral.sh/uv/):
+
 ```bash
-uv add processforge
+uv tool install processforge
 ```
 
 For CoolProp-backed units:
 
 ```bash
-uv add "processforge[coolprop]"
+uv tool install "processforge[coolprop]"
 ```
 
 Optional solver backends:
 
 ```bash
-uv add "processforge[eo]"
-uv add "processforge[eo-casadi]"
-uv add "processforge[modelica]"
+uv tool install "processforge[eo]"
+uv tool install "processforge[eo-casadi]"
+uv tool install "processforge[modelica]"
 ```
 
 ## Quick start
 
-Use `plan` to validate and preview changes, then `apply` to solve and store a snapshot. For flowsheets without Tank units, use `apply` to solve with the EO solver. 
+1. **Install the tool**
 
-```bash
-pf init
-pf plan flowsheets/hydraulic-chain.json
-pf apply flowsheets/hydraulic-chain.json
-```
-For flowsheets with Tank units, use `run` to solve with the SM solver. For direct run mode (for dynamic flowsheets with Tank units), use `run`:
+   ```bash
+   uv tool install processforge
+   ```
 
-```bash
-pf run flowsheets/hydraulic-chain.json
-```
+2. **Download an example flowsheet**
+
+   ```bash
+   curl -O https://raw.githubusercontent.com/urjanova/processforge/master/flowsheets/hydraulic-chain.json
+   ```
+
+3. **Initialize, plan, and apply**
+
+   ```bash
+   pf init
+   pf plan hydraulic-chain.json
+   pf apply hydraulic-chain.json
+   ```
+
+   `plan` validates the flowsheet (schema, DOF, units) without running the solver; `apply` solves it and stores a snapshot.
+
+4. **Look at the output**
+
+   `pf apply` writes results under `outputs/`:
+   - `*_results.zarr` — simulation results store
+   - `*_validation.xlsx` — validation report
+   - `*.pfstate/` — versioned snapshot store with a `latest` pointer
+
+   For flowsheets with Tank units (dynamic), use `pf run` instead of `pf apply` to solve with the SM solver.
 
 ## Python API
 

processforge-0.2.38/README.md

@@ -0,0 +1,82 @@
+# Processforge
+
+![processforge-logo](images/processforge-logo.svg)
+
+A lightweight Python framework for process simulation, coupling hydraulic, thermal, and reactor workflows.
+
+## Install
+
+Install the `pf` command-line tool with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install processforge
+```
+
+For CoolProp-backed units:
+
+```bash
+uv tool install "processforge[coolprop]"
+```
+
+Optional solver backends:
+
+```bash
+uv tool install "processforge[eo]"
+uv tool install "processforge[eo-casadi]"
+uv tool install "processforge[modelica]"
+```
+
+## Quick start
+
+1. **Install the tool**
+
+   ```bash
+   uv tool install processforge
+   ```
+
+2. **Download an example flowsheet**
+
+   ```bash
+   curl -O https://raw.githubusercontent.com/urjanova/processforge/master/flowsheets/hydraulic-chain.json
+   ```
+
+3. **Initialize, plan, and apply**
+
+   ```bash
+   pf init
+   pf plan hydraulic-chain.json
+   pf apply hydraulic-chain.json
+   ```
+
+   `plan` validates the flowsheet (schema, DOF, units) without running the solver; `apply` solves it and stores a snapshot.
+
+4. **Look at the output**
+
+   `pf apply` writes results under `outputs/`:
+   - `*_results.zarr` — simulation results store
+   - `*_validation.xlsx` — validation report
+   - `*.pfstate/` — versioned snapshot store with a `latest` pointer
+
+   For flowsheets with Tank units (dynamic), use `pf run` instead of `pf apply` to solve with the SM solver.
+
+## Python API
+
+```python
+from processforge import EOFlowsheet, validate_flowsheet
+config = validate_flowsheet("flowsheets/hydraulic-chain.json")
+fs = EOFlowsheet(config, backend="scipy")
+results = fs.run()
+```
+
+## Usage and Docker
+Processforge is also available as Docker images, and can be run in the cloud. See the [usage guide](docs/usage.md) for CLI commands, workflows, Docker, and cloud notes.
+
+## Flowsheets
+The core of Processforge is the flowsheet JSON format, which defines materials, units, and recycle rules. See below for more information on the formats and example flowsheets.
+- [docs/flowsheets.md](docs/flowsheets.md) : flowsheet JSON format, materials, units, and recycle rules
+- [flowsheets/](flowsheets/) : example flowsheets shipped with the repo
+
+
+## License
+
+BSD 3-Clause License

{processforge-0.2.34 → processforge-0.2.38}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "processforge"
-version = "0.2.34"
+version = "0.2.38"
 description = "A Python-based process simulation framework for chemical engineering applications."
 readme = "README.md"
 license = "BSD-3-Clause"
@@ -35,8 +35,6 @@ dependencies = [
     "pandas>=2.2",
     "zarr>=3.0",
     "coolprop>=7.2.0",
-    "pi>=0.1.2",
-    "pip>=26.1.2",
 ]
 
 [project.optional-dependencies]

{processforge-0.2.34 → processforge-0.2.38}/src/processforge.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: processforge
-Version: 0.2.34
+Version: 0.2.38
 Summary: A Python-based process simulation framework for chemical engineering applications.
 Author-email: Processforge Team <team@processforge.dev>
 License-Expression: BSD-3-Clause
@@ -29,8 +29,6 @@ Requires-Dist: graphviz>=0.20
 Requires-Dist: pandas>=2.2
 Requires-Dist: zarr>=3.0
 Requires-Dist: coolprop>=7.2.0
-Requires-Dist: pi>=0.1.2
-Requires-Dist: pip>=26.1.2
 Provides-Extra: eo
 Requires-Dist: pyomo>=6.7; extra == "eo"
 Provides-Extra: eo-casadi
@@ -66,38 +64,58 @@ A lightweight Python framework for process simulation, coupling hydraulic, therm
 
 ## Install
 
+Install the `pf` command-line tool with [uv](https://docs.astral.sh/uv/):
+
 ```bash
-uv add processforge
+uv tool install processforge
 ```
 
 For CoolProp-backed units:
 
 ```bash
-uv add "processforge[coolprop]"
+uv tool install "processforge[coolprop]"
 ```
 
 Optional solver backends:
 
 ```bash
-uv add "processforge[eo]"
-uv add "processforge[eo-casadi]"
-uv add "processforge[modelica]"
+uv tool install "processforge[eo]"
+uv tool install "processforge[eo-casadi]"
+uv tool install "processforge[modelica]"
 ```
 
 ## Quick start
 
-Use `plan` to validate and preview changes, then `apply` to solve and store a snapshot. For flowsheets without Tank units, use `apply` to solve with the EO solver. 
+1. **Install the tool**
 
-```bash
-pf init
-pf plan flowsheets/hydraulic-chain.json
-pf apply flowsheets/hydraulic-chain.json
-```
-For flowsheets with Tank units, use `run` to solve with the SM solver. For direct run mode (for dynamic flowsheets with Tank units), use `run`:
+   ```bash
+   uv tool install processforge
+   ```
 
-```bash
-pf run flowsheets/hydraulic-chain.json
-```
+2. **Download an example flowsheet**
+
+   ```bash
+   curl -O https://raw.githubusercontent.com/urjanova/processforge/master/flowsheets/hydraulic-chain.json
+   ```
+
+3. **Initialize, plan, and apply**
+
+   ```bash
+   pf init
+   pf plan hydraulic-chain.json
+   pf apply hydraulic-chain.json
+   ```
+
+   `plan` validates the flowsheet (schema, DOF, units) without running the solver; `apply` solves it and stores a snapshot.
+
+4. **Look at the output**
+
+   `pf apply` writes results under `outputs/`:
+   - `*_results.zarr` — simulation results store
+   - `*_validation.xlsx` — validation report
+   - `*.pfstate/` — versioned snapshot store with a `latest` pointer
+
+   For flowsheets with Tank units (dynamic), use `pf run` instead of `pf apply` to solve with the SM solver.
 
 ## Python API
 

{processforge-0.2.34 → processforge-0.2.38}/src/processforge.egg-info/SOURCES.txt

@@ -4,7 +4,6 @@ README.md
 pyproject.toml
 flowsheets/closed-loop-chain.json
 flowsheets/hydraulic-chain.json
-flowsheets/custom/simple_hyrdaulic_scheme.json
 flowsheets/festim/hydrogen_transport_1d.json
 flowsheets/openmc/msre_eigenvalue.json
 src/processforge/__init__.py

{processforge-0.2.34 → processforge-0.2.38}/src/processforge.egg-info/requires.txt

@@ -8,8 +8,6 @@ graphviz>=0.20
 pandas>=2.2
 zarr>=3.0
 coolprop>=7.2.0
-pi>=0.1.2
-pip>=26.1.2
 
 [cantera]
 cantera>=3.0

processforge-0.2.34/README.md

@@ -1,62 +0,0 @@
-# Processforge
-
-![processforge-logo](images/processforge-logo.svg)
-
-A lightweight Python framework for process simulation, coupling hydraulic, thermal, and reactor workflows.
-
-## Install
-
-```bash
-uv add processforge
-```
-
-For CoolProp-backed units:
-
-```bash
-uv add "processforge[coolprop]"
-```
-
-Optional solver backends:
-
-```bash
-uv add "processforge[eo]"
-uv add "processforge[eo-casadi]"
-uv add "processforge[modelica]"
-```
-
-## Quick start
-
-Use `plan` to validate and preview changes, then `apply` to solve and store a snapshot. For flowsheets without Tank units, use `apply` to solve with the EO solver. 
-
-```bash
-pf init
-pf plan flowsheets/hydraulic-chain.json
-pf apply flowsheets/hydraulic-chain.json
-```
-For flowsheets with Tank units, use `run` to solve with the SM solver. For direct run mode (for dynamic flowsheets with Tank units), use `run`:
-
-```bash
-pf run flowsheets/hydraulic-chain.json
-```
-
-## Python API
-
-```python
-from processforge import EOFlowsheet, validate_flowsheet
-config = validate_flowsheet("flowsheets/hydraulic-chain.json")
-fs = EOFlowsheet(config, backend="scipy")
-results = fs.run()
-```
-
-## Usage and Docker
-Processforge is also available as Docker images, and can be run in the cloud. See the [usage guide](docs/usage.md) for CLI commands, workflows, Docker, and cloud notes.
-
-## Flowsheets
-The core of Processforge is the flowsheet JSON format, which defines materials, units, and recycle rules. See below for more information on the formats and example flowsheets.
-- [docs/flowsheets.md](docs/flowsheets.md) : flowsheet JSON format, materials, units, and recycle rules
-- [flowsheets/](flowsheets/) : example flowsheets shipped with the repo
-
-
-## License
-
-BSD 3-Clause License

processforge-0.2.34/flowsheets/custom/simple_hyrdaulic_scheme.json

@@ -1,202 +0,0 @@
-{
-  "metadata": {
-    "name": "Hydraulic Chain Example",
-    "description": "A two-pump, one-valve, one-strainer steady-state hydraulic system.",
-    "version": "2.0"
-  },
-  "providers": {
-    "coolprop": {
-      "type": "coolprop"
-    }
-  },
-  "materials": {
-    "Benzene": {
-      "id": 1
-    },
-    "Toluene": {
-      "id": 2
-    },
-    "Steel": {
-      "id": 3
-    }
-  },
-  "material_mixes": {
-    "Benzene_Toluene_Mix": {
-      "friendly_material_mix_id": 1,
-      "percent_type": "ao",
-      "components": [
-        {"name": "Benzene", "fraction": 0.8},
-        {"name": "Toluene", "fraction": 0.2}
-      ]
-    }
-  },
-  "streams": {
-    "feed": {
-      "T": 298.15,
-      "P": 101325,
-      "flowrate": 38,
-      "material_mix": 1
-    }
-  },
-  "units": {
-    "pipe_1": {
-      "type": "Pipes",
-      "in": "feed",
-      "out": "after_pipe_1",
-      "delta_p": 1000.0,
-      "diameter": 0.040,
-      "material": 3
-    },
-    "valve_1": {
-      "type": "Valve",
-      "in": "after_pipe_1",
-      "out": "after_valve_1",
-      "pressure_ratio": 0.5,
-      "material": 3
-    },
-    "pipe_2": {
-      "type": "Pipes",
-      "in": "after_valve_1",
-      "out": "after_pipe_2",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "pump_1": {
-      "type": "Pump",
-      "in": "after_pipe_2",
-      "out": "after_pump_1",
-      "deltaP": 600000.0,
-      "efficiency": 0.75,
-      "material": 3
-    },
-    "pipe_3": {
-      "type": "Pipes",
-      "in": "after_pump_1",
-      "out": "after_pipe_3",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "strainer_1": {
-      "type": "Strainer",
-      "in": "after_pipe_3",
-      "out": "after_strainer_1",
-      "deltaP": 5000.0,
-      "material": 3
-    },
-    "pipe_4": {
-      "type": "Pipes",
-      "in": "after_strainer_1",
-      "out": "after_pipe_4",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "pipe_1a": {
-      "type": "Pipes",
-      "in": "after_strainer_1",
-      "out": "after_pipe_1a",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "valve_1a": {
-      "type": "Valve",
-      "in": "after_pipe_1a",
-      "out": "after_valve_1a",
-      "pressure_ratio": 0.5,
-      "material": 3
-    },
-    "pipe_2a": {
-      "type": "Pipes",
-      "in": "after_valve_1a",
-      "out": "after_pipe_2a",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "valve_2": {
-      "type": "Valve",
-      "in": "after_pipe_4",
-      "out": "after_valve_2",
-      "pressure_ratio": 0.5,
-      "material": 3
-    },
-    "pipe_5": {
-      "type": "Pipes",
-      "in": "after_valve_2",
-      "out": "after_pipe_5",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "pump_2": {
-      "type": "Pump",
-      "in": "after_pipe_5",
-      "out": "after_pump_2",
-      "deltaP": 600000.0,
-      "efficiency": 0.75,
-      "material": 3
-    },
-    "pipe_6": {
-      "type": "Pipes",
-      "in": "after_pump_2",
-      "out": "after_pipe_6",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "valve_3": {
-      "type": "Valve",
-      "in": "after_pipe_6",
-      "out": "after_valve_3",
-      "pressure_ratio": 0.5,
-      "material": 3
-    },
-    "pipe_7": {
-      "type": "Pipes",
-      "in": "after_valve_3",
-      "out": "after_pipe_7",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "valve_4": {
-      "type": "Valve",
-      "in": "after_pipe_7",
-      "out": "after_valve_4",
-      "pressure_ratio": 0.5,
-      "material": 3
-    },
-    "pipe_8": {
-      "type": "Pipes",
-      "in": "after_valve_4",
-      "out": "after_pipe_8",
-      "delta_p": 1000.0,
-      "diameter": 0.08,
-      "material": 3
-    },
-    "valve_5": {
-      "type": "Valve",
-      "in": ["after_pipe_8","after_pipe_2a"],
-      "out": "after_valve_5",
-      "pressure_ratio": 0.5,
-      "material": 3
-    },
-    "pipe_9": {
-      "type": "Pipes",
-      "in": "after_valve_5",
-      "out": "after_pipe_9",      
-      "delta_p": 1000.0,
-      "diameter": 0.025,
-      "material": 3
-    }
-    
-  },
-  "simulation": {
-    "mode":"dynamic",
-    "t_final": 20,
-    "t_step": 1 
-  }
-}