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 writes results under outputs/:

    • *_results.zarr — simulation results store (per-variable arrays, composition flattened)
    • *_results.zarr.schema.json — schema file describing streams, variables, dtypes, units, shapes, and run provenance
    • *.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

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 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.3.17.tar.gz (215.4 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.3.17-py3-none-any.whl (224.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for processforge-0.3.17.tar.gz
Algorithm Hash digest
SHA256 ab096e81820453454d44f89a810cc74c67c4a5e246aa93fd742321aa869be04e
MD5 dd42865f6a935af698e8e3ee6c2b0be9
BLAKE2b-256 0fcab5c07d76190afe98a95bfa39cad3b93fb68dde5663dee5463eccad10df09

See more details on using hashes here.

File details

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

File metadata

  • Download URL: processforge-0.3.17-py3-none-any.whl
  • Upload date:
  • Size: 224.6 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.3.17-py3-none-any.whl
Algorithm Hash digest
SHA256 2fd010a9ec2e4d9c208afc2766084a0cfdb2eff26b37a76a0bb40576f9dffe8c
MD5 5718dc50a4763e0c6bc8924118d56eaa
BLAKE2b-256 429300a78970d1cfa1634e284fa8eea090906257dee583f20da5aa6c641f4fa9

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

0.4.1

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

This release

0.3.17 This release

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