Processforge

processforge-logo

A lightweight Python framework for process simulation, coupling hydraulic, thermal, and reactor workflows.

Install

Install the pf command-line tool with uv:

uv tool install processforge

For CoolProp-backed units:

uv tool install "processforge[coolprop]"

Optional solver backends:

uv tool install "processforge[eo]"
uv tool install "processforge[eo-casadi]"
uv tool install "processforge[modelica]"

Quick start

  1. Install the tool

    uv tool install processforge

  2. Download an example flowsheet

    curl -O https://raw.githubusercontent.com/urjanova/processforge/master/flowsheets/hydraulic-chain.json

  3. Initialize, plan, and apply

    pf init flowsheets/hydraulic-chain.json
pf plan flowsheets/hydraulic-chain.json
pf apply flowsheets/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 (and pf run) write a single unified archive under outputs/:

    • outputs/<base>.pfarchive/ — the unified store for a flowsheet's solved state and outputs:
      • snapshots/ — Zarr store of converged state vectors (one group per successful pf apply), each with x/x_delta arrays and config/var-name/metadata attributes, plus a latest pointer (powers warm-start, drift detection, and homotopy).
      • runs/<run_id>.json — the run manifest: every stream and unit engine output (values, units, dtypes, shapes) and run provenance (backend, version, flowsheet hash).
      • outputs/streams/<name>.json — per-stream timeseries from the solve.
      • artifacts.json — content-addressed registry of all output artifacts (local + remote URIs).
      • index.json — field_name → occurrences index for fast cross-run lookups.
      • latest_run — plain-text pointer to the most recent run.
    • outputs/<base>_divergence.json — written only when both direct and homotopy solves fail on pf apply, capturing drifted params, solver stats, and top residual violators.

    For dynamic flowsheets with Tank units, use pf run (not pf apply, which is steady-state EO only) to solve with the dynamic engine.

Python API

from processforge import EOFlowsheet, validate_flowsheet
config = validate_flowsheet("flowsheets/hydraulic-chain.json")
fs = EOFlowsheet(config, backend="scipy")
results = fs.run()

Usage

See the usage guide for CLI commands and workflows.

Individual providers (e.g. FESTIM, OpenMC) can be run via Docker images using the provider image contract.

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.

License

BSD 3-Clause License

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.6.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for hrishiballal from gravatar.com hrishiballal

Credits

Author: Processforge Team

License expression

BSD-3-Clause
View SPDX License List

Requires

Python >=3.12

Provides Extra

api eo eo-casadi fmu modelica pathsim cantera coolprop dev docs

Tags

process simulation chemical engineering flowsheet

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

processforge-0.4.1.tar.gz (240.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

processforge-0.4.1-py3-none-any.whl (244.3 kB view details)

Uploaded Python 3

File details

Details for the file processforge-0.4.1.tar.gz.

File metadata

  • Download URL: processforge-0.4.1.tar.gz
  • Upload date:
  • Size: 240.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.0

File hashes

Hashes for processforge-0.4.1.tar.gz
Algorithm Hash digest
SHA256 ef7fbb26649bd14fa8b7f717e220e4be1a331ab1a30c42cc1869cbdb864bf85d
MD5 be085435a9674e16155c9900c49089d9
BLAKE2b-256 a9aca89f9ebd4939211beb4178006b205659facf42a20e7765bf18a6c20fa6b5

See more details on using hashes here.

File details

Details for the file processforge-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: processforge-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 244.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.0

File hashes

Hashes for processforge-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3dd00c4ea3436af4c18de0a34765d7e04004a56c406263fc26b10b3e6c2bbb14
MD5 477a84355c8c7e0c49e7c6a1d02ae7a2
BLAKE2b-256 56b438b1ac2e001e8621ec168f495f18a3a234b395b31faaf65fd85a337bc810

See more details on using hashes here.

Release history Release notifications | RSS feed

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

This release

0.4.1 This release

2 files

0.3.26

2 files

0.3.25

2 files

0.3.23

2 files

0.3.21

2 files

0.3.20

2 files

0.3.19

2 files

0.3.17

2 files

0.3.16

2 files

0.3.15

2 files

0.3.14

2 files

0.3.13

2 files

0.3.12

2 files

0.3.11

2 files

0.3.10

2 files

0.3.9

2 files

0.3.8

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.2.40

2 files

0.2.38

2 files

0.2.34

2 files

0.2.30

2 files

0.2.24

2 files

0.2.22

2 files

0.2.20

2 files

0.2.15

2 files

0.2.14

2 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.8

2 files

0.2.7

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page